Query heap descriptor structure. More...

#include <QueryHeapFlags.h>

Public Attributes
const char *	debugName = nullptr
	Optional name for debugging purposes. By default null.
QueryType	type = QueryType::SamplesPassed
	Specifies the type of queries in the heap. By default QueryType::SamplesPassed.
std::uint32_t	numQueries = 1
	Specifies the number of queries in the heap. This must be greater than zero. By default 1.
bool	renderCondition = false
	Specifies whether the queries are to be used as render conditions. By default false.

Detailed Description

Query heap descriptor structure.

See also: RenderSystem::CreateQueryHeap

Member Data Documentation

◆ debugName

const char* LLGL::QueryHeapDescriptor::debugName = nullptr

Optional name for debugging purposes. By default null.

Remarks: The final name of the native hardware resource is implementation defined.

See also: RenderSystemChild::SetDebugName

◆ numQueries

std::uint32_t LLGL::QueryHeapDescriptor::numQueries = 1

Specifies the number of queries in the heap. This must be greater than zero. By default 1.

◆ renderCondition

bool LLGL::QueryHeapDescriptor::renderCondition = false

Specifies whether the queries are to be used as render conditions. By default false.

Remarks

If this is true, the results of the queries cannot be retrieved by CommandBuffer::QueryResult and the member type can only have one of the following values:

Render conditions can be used to render complex geometry under the condition that a previous (commonly significantly smaller) geometry has passed the depth and stencil tests.

See also: CommandBuffer::BeginRenderCondition; CommandBuffer::EndRenderCondition

Note: Only supported with: OpenGL, Direct3D 11, Direct3D 12.

◆ type

QueryType LLGL::QueryHeapDescriptor::type = QueryType::SamplesPassed

Specifies the type of queries in the heap. By default QueryType::SamplesPassed.

The documentation for this struct was generated from the following file: