An SDL_GPUQueryPool and its metadata. More...

#include <QueryPool.h>

Inheritance diagram for QueryPool:

Public Member Functions
QueryPool *	initWithDevice (QueryPool self, RenderDevice device, const SDL_GPUQueryPoolCreateInfo *info)
	Initializes this QueryPool, creating its `SDL_GPUQueryPool`.

Class *	_QueryPool (void)
	The QueryPool archetype.

Data Fields
Object	object
	The superclass.

SDL_GPUQueryPool *	pool
	The underlying SDL query pool, or `NULL` if occlusion queries are unsupported by the linked SDL3 (see QueryPool.h).

SDL_GPUQueryType	type
	The type of query this pool was created for.

Uint32	queryCount
	The maximum number of queries in this pool.

ident	data
	User data.

Protected Attributes
QueryPoolInterface *	interface
	The interface.

Detailed Description

An SDL_GPUQueryPool and its metadata.

QueryPool owns its underlying SDL_GPUQueryPool and releases it in dealloc, so a QueryPool is freed with release like any other Objectively object. Begin and end queries against it via RenderPass::beginQuery / RenderPass::endQuery, and retrieve results via CopyPass::downloadQueryResults:

QueryPool *queries = $(renderDevice, createQueryPool,
  &(SDL_GPUQueryPoolCreateInfo) { .type = SDL_GPU_QUERY_BINARY_OCCLUSION, .query_count = 1 });
 
$(pass, beginQuery, queries, 0);
$(pass, drawPrimitives, ...);
$(pass, endQuery, queries, 0);
 
$(copyPass, downloadQueryResults, queries, 0, 1, &destination);
release(queries);

Member Function Documentation

◆ _QueryPool()

Class * _QueryPool ( void )

The QueryPool archetype.

Returns: The QueryPool Class.

◆ initWithDevice()

QueryPool * initWithDevice	(	QueryPool *	self,
		RenderDevice *	device,
		const SDL_GPUQueryPoolCreateInfo *	info
	)

Initializes this QueryPool, creating its SDL_GPUQueryPool.

This is the designated initializer. Always succeeds, even when occlusion queries are unsupported by the linked SDL3 – self->pool is NULL in that case, and the pool behaves as an inert no-op.

Parameters

self	The QueryPool.
device	The RenderDevice used to create and release the query pool. Retained.
info	Query pool creation parameters (query type, query count).

Returns: The initialized QueryPool, or NULL on failure.

Field Documentation

◆ data

ident QueryPool::data

User data.

◆ interface

QueryPoolInterface* QueryPool::interface

protected

The interface.

◆ object

Object QueryPool::object

The superclass.

◆ pool

SDL_GPUQueryPool* QueryPool::pool

The underlying SDL query pool, or NULL if occlusion queries are unsupported by the linked SDL3 (see QueryPool.h).

◆ queryCount

Uint32 QueryPool::queryCount

The maximum number of queries in this pool.

◆ type

SDL_GPUQueryType QueryPool::type

The type of query this pool was created for.

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

Sources/ObjectivelyGPU/QueryPool.h
Sources/ObjectivelyGPU/QueryPool.c

Public Member Functions

Data Fields

Protected Attributes