C++ group Rendering::Helper
Helper

void

Description

Classes

class	Rendering::OcclusionQuery
class	Rendering::QueryObject
class	Rendering::StatisticsQuery

Functions

void	enableGLErrorChecking()
void	disableGLErrorChecking()
void	checkGLError(const char * file, int line)
const char *	getGLTypeString(uint32_t type)
uint32_t	getGLTypeSize(uint32_t type)
uint32_t	getGLType( Util::TypeConstant type)
Util::TypeConstant	getAttributeType(uint32_t glType)
void	outputGLInformation(std::ostream & output)
const char *	getGraphicsLanguageVersion()
const char *	getShadingLanguageVersion()
bool	isExtensionSupported(const char * extension)
float	readDepthValue(int32_t x, int32_t y)
void	enableDebugOutput()
void	disableDebugOutput()
void	pushDebugGroup(const std::string & name)
void	popDebugGroup()
void	triggerCapture()
void	startCapture()
void	endCapture()

---

Documentation

function
enableGLErrorChecking

public

void enableGLErrorChecking(	)

_{Defined in Rendering/Helper.h:27}

---

function
disableGLErrorChecking

public

void disableGLErrorChecking(	)

_{Defined in Rendering/Helper.h:28}

---

function
checkGLError

public

void checkGLError(	const char *	file,
	int	line
)

_{Defined in Rendering/Helper.h:29}

---

function
getGLTypeString

public

const char * getGLTypeString(	uint32_t	type )

Return a human-readable description for the given OpenGL type.

Parameters

type

Valid values are GL_BOOL, GL_UNSIGNED_BYTE, GL_BYTE, GL_UNSIGNED_SHORT, GL_SHORT, GL_UNSIGNED_INT, GL_INT, GL_FLOAT, and GL_DOUBLE.

Returns

String description of the type, or an empty string if the type is invalid.

_{Defined in Rendering/Helper.h:37}

---

function
getGLTypeSize

public

uint32_t getGLTypeSize(	uint32_t	type )

Return the size of the given OpenGL type.

Parameters

type

Valid values are GL_BOOL, GL_UNSIGNED_BYTE, GL_BYTE, GL_UNSIGNED_SHORT, GL_SHORT, GL_UNSIGNED_INT, GL_INT, GL_FLOAT, and GL_DOUBLE.

Returns

Size in bytes, or zero if the type is invalid.

_{Defined in Rendering/Helper.h:45}

---

function
getGLType

public

uint32_t getGLType(	Util::TypeConstant	type )

Returns the OpenGL type for the given resource attribute type.

Parameters

type

the attribute type (e.g., TypeConstant).

Returns

The corresponding OpenGL type constant.

_{Defined in Rendering/Helper.h:53}

---

function
getAttributeType

public

Util::TypeConstant getAttributeType(	uint32_t	glType )

Returns the resource attribute type for the given OpenGL type.

Parameters

type

the OpenGL type.

Returns

The corresponding attribute type.

_{Defined in Rendering/Helper.h:61}

---

function
outputGLInformation

public

void outputGLInformation(	std::ostream &	output )

Write information about the current OpenGL context to the given stream.

Parameters

output

Output stream that the data is written to

See also: glGetString

_{Defined in Rendering/Helper.h:69}

---

function
getGraphicsLanguageVersion

public

const char * getGraphicsLanguageVersion(	)

Return the supported graphics language version.

Returns

Null-terminated string containing the supported graphics language version

See also: constantGL_VERSIONof functionglGetString

See also: glewIsSupported

_{Defined in Rendering/Helper.h:78}

---

function
getShadingLanguageVersion

public

const char * getShadingLanguageVersion(	)

Return the supported shading language version.

Returns

Null-terminated string containing the supported shading language version

See also: constantGL_SHADING_LANGUAGE_VERSIONof functionglGetString

_{Defined in Rendering/Helper.h:86}

---

function
isExtensionSupported

public

bool isExtensionSupported(	const char *	extension )

Check for support of a specific OpenGL extension.

Parameters

extension

Null-terminated string containing the name of the requested extension

Returns

trueif the requested extension is supported,falseotherwise.

See also: glewIsSupported

_{Defined in Rendering/Helper.h:95}

---

function
readDepthValue

public

float readDepthValue(	int32_t	x,
	int32_t	y
)

Read a single value from the depth buffer.

See also: glReadPixels

_{Defined in Rendering/Helper.h:102}

---

function
enableDebugOutput

public

void enableDebugOutput(	)

Enable debug output that can be used to find errors or performance problems.

See also: OpenGL extensionGL_ARB_debug_output

_{Defined in Rendering/Helper.h:109}

---

function
disableDebugOutput

public

void disableDebugOutput(	)

Disable the debug output again.

See also: enableDebugOutput()

_{Defined in Rendering/Helper.h:116}

---

function
pushDebugGroup

public

void pushDebugGroup(	const std::string &	name )

Push a named debug group into the command stream

Parameters

name

Name of the debug group

See also: glPushDebugGroup

_{Defined in Rendering/Helper.h:124}

---

function
popDebugGroup

public

void popDebugGroup(	)

Pop the active debug group

See also: glPopDebugGroup

_{Defined in Rendering/Helper.h:130}

---

function
triggerCapture

public

void triggerCapture(	)

Triggers a capture of the current GL state in RenderDoc.

Note: Requires RenderDoc

_{Defined in Rendering/Helper.h:136}

---

function
startCapture

public

void startCapture(	)

Starts capturing of the GL state in RenderDoc.

Note: Requires RenderDoc

_{Defined in Rendering/Helper.h:142}

---

function
endCapture

public

void endCapture(	)

Ends the active capture.

Note: Requires RenderDoc

_{Defined in Rendering/Helper.h:148}

---