cs237 Namespace Reference

Namespaces
namespace	__detail
namespace	gobj

Classes
class	Application
	the base class for applications More...
class	Attachment
	Frame-buffer attachments for off-screen rendering support. More...
class	Buffer
	A base class for buffer objects of all kinds. More...
struct	CreateWindowInfo
	structure containing parameters for creating windows More...
class	DataImage2D
	A 2D Image used to store 2D data, such as a normal map. More...
class	DepthAttachment
	Depth-buffer attachment for off-screen rendering. More...
class	DepthBuffer
class	Image1D
class	Image2D
class	IndexBuffer
	Buffer class for index data; the type parameter I is the index type. More...
class	MemoryObj
	wrapper around Vulkan memory objects More...
class	Shaders
class	StorageBuffer
class	StorageVertexBuffer
class	Texture1D
class	Texture2D
class	UniformBuffer
class	VertexBuffer
class	Window
	abstract base class for simple GLFW windows used to view buffers, etc. More...

Typedefs
using	AABBf_t = __detail::AABB<float>
	Single-precision axis-aligned bounding boxes.
using	AABBd_t = __detail::AABB<double>
	Double-precision axis-aligned bounding boxes.
using	Planef_t = __detail::Plane<float>
	Single-precision planes.
using	Planed_t = __detail::Plane<double>
	Double-precision planes.

Enumerations
enum class	Channels {   UNKNOWN , R , RG , RGB ,   BGR , RGBA , BGRA }
	the channels of an image More...
enum class	ChannelTy {   UNKNOWN , U8 , S8 , U16 ,   S16 , U32 , S32 , F32 }
	the type used to represent the channels More...

Functions
void	ReportError (const char *file, int line, std::string const &msg)
std::string	to_string (Channels ch)
	convert a Channels value to a printable string
std::string	to_string (ChannelTy ty)
	convert a ChannelTy value to a printable string
vk::PipelineVertexInputStateCreateInfo	vertexInputInfo (std::vector< vk::VertexInputBindingDescription > const &descs, std::vector< vk::VertexInputAttributeDescription > const &attrs)
	initialize info for the vertex input stage of the pipeline
void	destroyVertexInputInfo (vk::PipelineVertexInputStateCreateInfo &info)
	release resources allocated by vertexInputInfo

Variables
constexpr int	kMaxFrames = MAX_FRAMES

Typedef Documentation

AABBd_t

using cs237::AABBd_t = __detail::AABB<double>

Double-precision axis-aligned bounding boxes.

AABBf_t

using cs237::AABBf_t = __detail::AABB<float>

Single-precision axis-aligned bounding boxes.

Planed_t

using cs237::Planed_t = __detail::Plane<double>

Double-precision planes.

Planef_t

using cs237::Planef_t = __detail::Plane<float>

Single-precision planes.

Enumeration Type Documentation

Channels

enum class cs237::Channels

strong

the channels of an image

Enumerator
UNKNOWN	unknown
R	single-channel image
RG	two-channel image
RGB	three-channel image in red-green-blue order
BGR	three-channel image in blue-green-red order
RGBA	four-channel image in red-green-n-blue-alpha order
BGRA	four-channel image in blue-green-red-alpha order

ChannelTy

enum class cs237::ChannelTy

strong

the type used to represent the channels

Enumerator
UNKNOWN	unknown type
U8	unsigned byte
S8	signed byte
U16	unsigned 16-bit int
S16	signed 16-bit int
U32	unsigned 32-bit int
S32	signed 32-bit int
F32	signed 32-bit float

Function Documentation

destroyVertexInputInfo()

void cs237::destroyVertexInputInfo ( vk::PipelineVertexInputStateCreateInfo & info )

inline

release resources allocated by vertexInputInfo

ReportError()

void cs237::ReportError ( const char * file, int line, std::string const & msg )

inline

function for reporting errors by raising a runtime exception that includes the file and line number of the error.

to_string() [1/2]

std::string cs237::to_string

(

Channels

ch

)

convert a Channels value to a printable string

to_string() [2/2]

std::string cs237::to_string

(

ChannelTy

ty

)

convert a ChannelTy value to a printable string

vertexInputInfo()

vk::PipelineVertexInputStateCreateInfo cs237::vertexInputInfo ( std::vector< vk::VertexInputBindingDescription > const & descs, std::vector< vk::VertexInputAttributeDescription > const & attrs )

inline

initialize info for the vertex input stage of the pipeline

Parameters

descs	vector of binding descriptors
attrs	vector of input attributes

The resources allocated by this function should be released by calling the destroyVertexInputInfo function.

Variable Documentation

kMaxFrames

int cs237::kMaxFrames = MAX_FRAMES

constexpr

the maximum number of frames allowed "in flight". This value defaults to 2 (for double buffering), but can be overridden by defining the macro CS237_MAX_FRAMES_IN_FLIGHT to some other value.