Represents a graphics device context which can receive rendering commands. More...

#include <IContext.h>

Inheritance diagram for Cogs::IContext:

Public Member Functions
virtual const Cogs::FrameStatistics &	getLastFrameStatistics ()=0

virtual const Cogs::UploadStatistics &	getLastUploadStatistics ()=0

virtual void	frameStatisticsConfigure (bool enable)=0

virtual void	clearCachedState ()
	Prepare context for external manipulation of graphics device.

virtual void	pushCommandGroupAnnotation (const StringView &name)
	Begin to tag a sequence of commands as a group in graphics debugger.

virtual void	popCommandGroupAnnotation ()
	End to tag a sequence of commands as a group in graphics debugger.

virtual void	setAnnotationMarker (const StringView &name)
	Add a tag in the sequence of commands in graphics debugger.

virtual void	beginRenderPass (const RenderPassInfo &info)=0
	Begin a render pass.

virtual void	endRenderPass ()=0
	End a render pass.

virtual void	setRenderTarget (const RenderTargetHandle handle, const DepthStencilHandle depthStencilHandle)=0
	Sets the current render target and an associated depth stencil target.

virtual void	setViewport (const float x, const float y, const float width, const float height)=0
	Sets the current viewport to the given location and dimensions.

virtual void	setScissor (const int x, const int y, const int width, const int height)=0
	Sets the current scissor rectangle.

virtual void	clearRenderTarget (const float *value)=0
	Clear the currently set render target to the given value (4 component floating point RGBA).

virtual void	clearRenderTarget (const float **values, const int numvalues)=0
	Clear the currently set render target, setting the individual render target views to the given values (4 component floating point RGBA).

virtual void	clearDepth (const float depth=1.0f)=0
	Clear the currently set depth/stencil target to the given depth.

virtual void	setDepthStencilState (const DepthStencilStateHandle handle)=0
	Set the current depth stencil state.

virtual void	setBlendState (const BlendStateHandle handle, const float *constant=nullptr)=0
	Set the current blend state.

virtual void	setRasterizerState (const RasterizerStateHandle handle)=0
	Set the current rasterizer state.

virtual void	setEffect (EffectHandle handle)=0
	Set the current effect.

virtual void	setMatrixVariable (const StringView &name, const float *value)=0
	Sets the matrix variable with the given name in the current effect to value.

virtual void	setScalarVariable (const StringView &name, const float value)=0
	Sets the scalar floating point variable with the given name to the given value.

virtual void	setScalarVariable (const StringView &name, int value)=0
	Sets the scalar integer variable with the given name to the given value.

virtual void	setVector2Variable (const StringView &name, const float *value)=0
	Sets the vector variable with the given name to the given two-component value.

virtual void	setVector3Variable (const StringView &name, const float *value)=0
	Sets the vector variable with the given name to the given three-component value.

virtual void	setVector4Variable (const StringView &name, const float *value)=0
	Sets the vector variable with the given name to the given four-component value.

virtual void	setVariable (const EffectVariableHandle index, const uint8_t *data, size_t size)=0
	Sets the variable with the given name and size.

virtual void	setMatrixVariable (const EffectVariableHandle variableHandle, const float *value)=0
	Sets the given matrix variable to value.

virtual void	setMatrixVariable (const EffectVariableHandle variableHandle, const float *value, size_t count)=0
	Sets the given matrix variable to value.

virtual void	setScalarVariable (const EffectVariableHandle variableHandle, const float value)=0
	Sets the given scalar floating point variable to the given value.

virtual void	setScalarVariable (const EffectVariableHandle variableHandle, const float *value, size_t count)=0
	Sets the given scalar integer point variable to the given value.

virtual void	setScalarVariable (const EffectVariableHandle variableHandle, int value)=0
	Sets the given scalar integer point variable to the given value.

virtual void	setScalarVariable (const EffectVariableHandle variableHandle, const int *value, size_t count)=0
	Sets the given scalar integer point variable to the given value.

virtual void	setVector2Variable (const EffectVariableHandle variableHandle, const float *value, size_t count=1)=0
	Sets the given vector variable to the given two-component value.

virtual void	setVector3Variable (const EffectVariableHandle variableHandle, const float *value, size_t count=1)=0
	Sets the given vector variable to the given three-component value.

virtual void	setVector4Variable (const EffectVariableHandle variableHandle, const float *value, size_t count=1)=0
	Sets the given vector variable to the given four-component value.

virtual void	setVector4Variable (const EffectVariableHandle variableHandle, const int *value, size_t count=1)=0
	Sets the given vector variable to the given four-component value.

virtual void	setTexture (const StringView &name, unsigned int unit, TextureHandle textureHandle)=0
	Sets the texture slot given by unit with the given name to contain the given texture.

virtual void	setTexture (const TextureBindingHandle textureBindingHandle, const TextureHandle textureHandle)=0
	Sets the texture given to the binding given by textureBindingHandle.

virtual void	setTexture (const StringView &name, TextureViewHandle textureViewHandle)=0

virtual void	setTexture (const TextureBindingHandle textureBindingHandle, TextureViewHandle textureViewHandle)=0

virtual void	setSamplerState (const StringView &name, unsigned int unit, SamplerStateHandle samplerStateHandle)=0
	Sets the sampler slot given by unit with the given name to contain the given sampler state.

virtual void	setSamplerState (const SamplerStateBindingHandle samplerStateBindingHandle, const SamplerStateHandle samplerStateHandle)=0
	Sets the sampler state binding given to the given sampler state.

virtual void	setInputLayout (const InputLayoutHandle inputLayoutHandle)=0
	Sets the current input layout.

virtual void	setVertexBuffers (const VertexBufferHandle vertexBufferHandles, const size_t count, const uint32_t strides, const uint32_t *offsets)=0
	Sets the current vertex buffers.

virtual void	setVertexBuffers (const VertexBufferHandle *vertexBufferHandles, const size_t count)=0
	Overload provided to support transitioning.

virtual void	setIndexBuffer (IndexBufferHandle bufferHandle, uint32_t stride=4, uint32_t offset=0)=0
	Sets the current index buffer.

virtual void	setVertexArrayObject (VertexArrayObjectHandle vertexArrayObject)=0
	Sets vertexBuffers and index buffers using a prevalidated vertex array object.

virtual void	setConstantBuffer (const StringView &name, const BufferHandle bufferHandle, const uint32_t offset=0, const uint32_t size=~0u)=0
	Sets a constant buffer to be bound to the given name and slot.

virtual void	setConstantBuffer (const ConstantBufferBindingHandle bufferBindingHandle, const BufferHandle bufferHandle, const uint32_t offset=0, const uint32_t size=~0u)=0
	Sets a constant buffer to the given constant buffer binding.

virtual void	setBuffer (const StringView &name, BufferHandle bufferHandle)=0
	Sets the given buffer to the buffer binding slot with the given name.

virtual void	setBuffer (const BufferBindingHandle bufferBindingHandle, BufferHandle bufferHandle)=0
	Sets a buffer to bind to the given binding.

virtual void	setBufferCounter (BufferHandle bufferHandle, uint32_t value)=0
	Set the associated counter of a buffer.

virtual void	setBufferCounter (BufferHandle bufferHandle, BufferHandle sourceBufferHandle)=0
	Set the associated counter of a buffer.

virtual void	getBufferCounter (BufferHandle bufferHandle, BufferHandle destinationBufferHandle)=0
	Get the associated counter of a buffer.

virtual uint32_t	getBufferCounter (BufferHandle bufferHandle)=0
	Get the associated counter of a buffer.

virtual void	draw (PrimitiveType::EPrimitiveType primitiveType, const size_t startVertex, const size_t numVertexes)=0
	Draws non-indexed, non-instanced primitives.

virtual void	drawIndexed (PrimitiveType::EPrimitiveType primitiveType, const size_t startIndex, const size_t numIndexes, const size_t startVertex=0)=0
	Draws indexed, non-instanced primitives.

virtual void	drawInstanced (PrimitiveType::EPrimitiveType primitiveType, const size_t startVertex, const size_t numVertexes, const size_t startInstance, const size_t numInstances)=0
	Draws non-indexed, instanced primitives.

virtual void	drawInstancedIndexed (PrimitiveType::EPrimitiveType primitiveType, const size_t startInstance, const size_t numInstances, const size_t startIndex, const size_t numIndexes)=0
	Draws indexed, instanced primitives.

virtual void	dispatchCompute (const unsigned int threadGroupsX, const unsigned int threadGroupsY, const unsigned int threadGroupsZ)=0
	Dispatch computing work on the graphics device using the desired thread group count.

virtual void	resolveResource (TextureHandle source, TextureHandle destination)=0
	Resolves the given source resource target into the given destination texture.

virtual void	readDepthBuffer (BufferHandle bufferHandle, int x, int y, int width, int height, Framebuffer::EFrameBuffer framebuffer)=0
	Reads data from the current depth target into the given bufferHandle.

virtual void	readColorBuffer (BufferHandle bufferHandle, int x, int y, int width, int height, Framebuffer::EFrameBuffer framebuffer)=0
	Reads data from the current render target into the given bufferHandle.

virtual void *	map (BufferHandle bufferHandle, MapMode::EMapMode mapMode, uint32_t *stride=nullptr)=0
	Maps the given buffer so it can be accessed.

virtual void	unmap (BufferHandle bufferHandle)=0
	Unmaps the given buffer, applying any synchronization necessary to reflect changes in the mapped memory.

virtual void	updateBuffer (BufferHandle bufferHandle, const void *data, size_t size)=0
	Replace contents of buffer with new data.

virtual void *	map (TextureHandle textureHandle, MapMode::EMapMode accessMode, uint32_t rowPitch, uint32_t depthPitch)=0
	Create host mapping of a staging texture.

virtual void	unmap (TextureHandle textureHandle)=0
	Release a host mapping of a staging texture.

virtual void	signal (FenceHandle fenceHandle)=0
	Insert a fence in the command stream that will signal when all commands before the fence are completed.

virtual void	updateSubTexture (TextureHandle textureHandle, const size_t level, const void *data)=0
	Update the data of a level in the given texture.

virtual void	updateSubBuffer (BufferHandle bufferHandle, const size_t offset, const size_t size, const void *data)=0
	Update a region of data in a buffer.

virtual void	copyResource (BufferHandle destinationHandle, BufferHandle sourceHandle)=0

virtual void	copyResource (TextureHandle destinationHandle, TextureHandle sourceHandle)=0

virtual void	copyTexture (TextureHandle dstHandle, unsigned dstSub, unsigned dstX, unsigned dstY, unsigned dstZ, TextureHandle sourceHandle, unsigned srcSub)=0

virtual void	clearResource (BufferHandle destinationHandle, uint32_t *Values)=0

virtual void	clearResource (BufferHandle destinationHandle, float *Values)=0

virtual void	reset ()
	Resets all state changes made to the GPU since the last call to beginFrame.

Detailed Description

Represents a graphics device context which can receive rendering commands.

Definition at line 42 of file IContext.h.

Member Function Documentation

◆ beginRenderPass()

virtual void Cogs::IContext::beginRenderPass ( const RenderPassInfo & info )

pure virtual

Begin a render pass.

Render passes encapsulate binding render targets, multisample resolve and load and store operations.

While in a render pass do NOT use setRenderTarget(), clearRenderTarget(), clearDepth().

Check GraphicsDeviceCapabilities::RenderPass for support.

Implemented in Cogs::ContextNull, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, and Cogs::ContextWebGPU.

◆ clearCachedState()

virtual void Cogs::IContext::clearCachedState ( )

inlinevirtual

Prepare context for external manipulation of graphics device.

Primarily relevant in WebGL to allow javascript to do GL calls without interfering with context's cached state.

Reimplemented in Cogs::ContextGLES30.

Definition at line 55 of file IContext.h.

◆ clearDepth()

virtual void Cogs::IContext::clearDepth ( const float depth = 1.0f )

pure virtual

Clear the currently set depth/stencil target to the given depth.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ clearRenderTarget() [1/2]

virtual void Cogs::IContext::clearRenderTarget	(	const float **	values,
		const int	numvalues
	)

pure virtual

Clear the currently set render target, setting the individual render target views to the given values (4 component floating point RGBA).

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, and Cogs::ContextD3D11.

◆ clearRenderTarget() [2/2]

virtual void Cogs::IContext::clearRenderTarget ( const float * value )

pure virtual

Clear the currently set render target to the given value (4 component floating point RGBA).

If the render target has less than 4 components, only the first n components need to be intended values.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, and Cogs::ContextD3D11.

◆ dispatchCompute()

virtual void Cogs::IContext::dispatchCompute	(	const unsigned int	threadGroupsX,
		const unsigned int	threadGroupsY,
		const unsigned int	threadGroupsZ
	)

pure virtual

Dispatch computing work on the graphics device using the desired thread group count.

Parameters

threadGroupsX	Number of work groups spawned in the X dimension.
threadGroupsY	Number of work groups spawned in the Y dimension.
threadGroupsZ	Number of work groups spawned in the Z dimension.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextVK, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ draw()

virtual void Cogs::IContext::draw	(	PrimitiveType::EPrimitiveType	primitiveType,
		const size_t	startVertex,
		const size_t	numVertexes
	)

pure virtual

Draws non-indexed, non-instanced primitives.

Parameters

primitiveType	Primitive type to assemble from the bound vertex buffers.
startVertex	Index of the first vertex in the bound vertex buffers to start at when drawing.
numVertexes	Number of vertexes to draw.

Implemented in Cogs::ContextGL20, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ drawIndexed()

virtual void Cogs::IContext::drawIndexed	(	PrimitiveType::EPrimitiveType	primitiveType,
		const size_t	startIndex,
		const size_t	numIndexes,
		const size_t	startVertex = `0`
	)

pure virtual

Draws indexed, non-instanced primitives.

Parameters

primitiveType	Primitive type to assemble from the bound vertex buffers.
startIndex	Index of the first item in the index buffer to start at when drawing.
numIndexes	Number of indexes to draw.
startVertex	Index of the base vertex in the vertex buffer to index from.

Implemented in Cogs::ContextD3D12, Cogs::ContextVK, Cogs::ContextD3D11, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ drawInstanced()

virtual void Cogs::IContext::drawInstanced	(	PrimitiveType::EPrimitiveType	primitiveType,
		const size_t	startVertex,
		const size_t	numVertexes,
		const size_t	startInstance,
		const size_t	numInstances
	)

pure virtual

Draws non-indexed, instanced primitives.

Parameters

primitiveType	Primitive type to assemble from the bound vertex buffers.
startVertex	Index of the first vertex in the bound vertex buffers to start at when drawing each instance.
numVertexes	Number of vertexes to draw per instance.
startInstance	Index of the first instance to start drawing at.
numInstances	Number of instances to draw.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ drawInstancedIndexed()

virtual void Cogs::IContext::drawInstancedIndexed	(	PrimitiveType::EPrimitiveType	primitiveType,
		const size_t	startInstance,
		const size_t	numInstances,
		const size_t	startIndex,
		const size_t	numIndexes
	)

pure virtual

Draws indexed, instanced primitives.

Parameters

primitiveType	Primitive type to assemble from the bound vertex buffers.
startInstance	Index of the first instance to start drawing at.
numInstances	Number of instances to draw.
startIndex	Index of the first item in the index buffer to start at when drawing each instance.
numIndexes	Number of indexes to draw per instance.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ endRenderPass()

virtual void Cogs::IContext::endRenderPass ( )

pure virtual

End a render pass.

Implemented in Cogs::ContextVK, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextNull, Cogs::ContextGL20, Cogs::ContextGLES30, and Cogs::ContextWebGPU.

◆ getBufferCounter() [1/2]

virtual uint32_t Cogs::IContext::getBufferCounter ( BufferHandle bufferHandle )

pure virtual

Get the associated counter of a buffer.

Returns: The value of the counter.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ getBufferCounter() [2/2]

virtual void Cogs::IContext::getBufferCounter	(	BufferHandle	bufferHandle,
		BufferHandle	destinationBufferHandle
	)

pure virtual

Get the associated counter of a buffer.

Parameters

bufferHandle	Handle to the buffer to get the counter from. This buffer must have been created with the StructuredBufferWithCounter bind flag.
destinationBufferHandle	Handle to a buffer to copy the counter value to.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ map() [1/2]

virtual void * Cogs::IContext::map	(	BufferHandle	bufferHandle,
		MapMode::EMapMode	mapMode,
		uint32_t *	stride = `nullptr`
	)

pure virtual

Maps the given buffer so it can be accessed.

Parameters

bufferHandle	Valid handle to a buffer containing data to be read.
mapMode	Mapping mode to apply when mapping the buffer.
stride	Optional pointer to a stride value. Must be set for aliased buffer texture resources.

Returns: A pointer to the memory mapped from the buffer. If the operation failed, returns nullptr.

See also: MapMode

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

Referenced by Cogs::MappedBuffer< MappedDataType >::MappedBuffer().

◆ map() [2/2]

virtual void * Cogs::IContext::map	(	TextureHandle	textureHandle,
		MapMode::EMapMode	accessMode,
		uint32_t *	rowPitch,
		uint32_t *	depthPitch
	)

pure virtual

Create host mapping of a staging texture.

Parameters

	textureHandle	Staging texture.
	accessMode	MapMode::Write (requires TextureFlags::UsageWriteStaging) or MapMode::Read (requires TextureFlags::UsageReadStaging).
[out]	rowPitch	Number of bytes between successive rows in the mapping.
[out]	depthPitch	Number of bytes between successive slices in the mapping.

Returns: A pointer to the start of the memory range of the mapping.

See also: unmap

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextVK, Cogs::ContextNull, Cogs::ContextGL20, Cogs::ContextGLES30, and Cogs::ContextWebGPU.

◆ popCommandGroupAnnotation()

virtual void Cogs::IContext::popCommandGroupAnnotation ( )

inlinevirtual

End to tag a sequence of commands as a group in graphics debugger.

Reimplemented in Cogs::ContextD3D11, and Cogs::ContextGL20.

Definition at line 67 of file IContext.h.

◆ pushCommandGroupAnnotation()

virtual void Cogs::IContext::pushCommandGroupAnnotation ( const StringView & name )

inlinevirtual

Begin to tag a sequence of commands as a group in graphics debugger.

Groups can be strictly nested, and a push must always be paired with a pop.

Reimplemented in Cogs::ContextD3D11, and Cogs::ContextGL20.

Definition at line 62 of file IContext.h.

◆ readColorBuffer()

virtual void Cogs::IContext::readColorBuffer	(	BufferHandle	bufferHandle,
		int	x,
		int	y,
		int	width,
		int	height,
		Framebuffer::EFrameBuffer	framebuffer
	)

pure virtual

Reads data from the current render target into the given bufferHandle.

Parameters

bufferHandle	Buffer to read the data into. Must be at least of size (width * height * sizeof(ColorFormat)).
x	Address of the first pixel on the x-axis to read from.
y	Address of the first pixel on the y-axis to read from.
width	Width of the data to read in pixels.
height	Height of the data to read in pixels.
framebuffer	Frame buffer to read from. Applicable when e.g reading from the default double-buffered render target.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ readDepthBuffer()

virtual void Cogs::IContext::readDepthBuffer	(	BufferHandle	bufferHandle,
		int	x,
		int	y,
		int	width,
		int	height,
		Framebuffer::EFrameBuffer	framebuffer
	)

pure virtual

Reads data from the current depth target into the given bufferHandle.

Parameters

bufferHandle	Buffer to read the data into. Must be at least of size (width * height * sizeof(DepthFormat)).
x	Address of the first pixel on the x-axis to read from.
y	Address of the first pixel on the y-axis to read from.
width	Width of the data to read in pixels.
height	Height of the data to read in pixels.
framebuffer	Frame buffer to read from. Applicable when e.g reading from the default double-buffered depth target.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ reset()

virtual void Cogs::IContext::reset ( )

inlinevirtual

Resets all state changes made to the GPU since the last call to beginFrame.

Reimplemented in Cogs::ContextGL20, and Cogs::ContextGLES30.

Definition at line 593 of file IContext.h.

◆ resolveResource()

virtual void Cogs::IContext::resolveResource	(	TextureHandle	source,
		TextureHandle	destination
	)

pure virtual

Resolves the given source resource target into the given destination texture.

The source texture is assumed to be a multisample format handled by the GPU internally. This method can be used to resolve such a texture so that it may later be used as a regular texture data (multisampled textures cannot be read by standard samplers).

If using multisample samplers in shaders, this step is not necessary to perform.

Implemented in Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextD3D11, Cogs::ContextNull, and Cogs::ContextWebGPU.

Referenced by Cogs::Core::CameraSystem::postRender().

◆ setAnnotationMarker()

virtual void Cogs::IContext::setAnnotationMarker ( const StringView & name )

inlinevirtual

Add a tag in the sequence of commands in graphics debugger.

Reimplemented in Cogs::ContextD3D11, and Cogs::ContextGL20.

Definition at line 72 of file IContext.h.

◆ setBlendState()

virtual void Cogs::IContext::setBlendState	(	const BlendStateHandle	handle,
		const float *	constant = `nullptr`
	)

pure virtual

Set the current blend state.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setBuffer() [1/2]

virtual void Cogs::IContext::setBuffer	(	const BufferBindingHandle	bufferBindingHandle,
		BufferHandle	bufferHandle
	)

pure virtual

Sets a buffer to bind to the given binding.

Parameters

bufferBindingHandle	Handle to a buffer binding.
bufferHandle	Handle to a buffer to set.

Implemented in Cogs::ContextVK, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setBuffer() [2/2]

virtual void Cogs::IContext::setBuffer	(	const StringView &	name,
		BufferHandle	bufferHandle
	)

pure virtual

Sets the given buffer to the buffer binding slot with the given name.

Parameters

name	Name of the buffer binding in the effect.
bufferHandle	Handle to a buffer to set.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextCommon.

◆ setBufferCounter() [1/2]

virtual void Cogs::IContext::setBufferCounter	(	BufferHandle	bufferHandle,
		BufferHandle	sourceBufferHandle
	)

pure virtual

Set the associated counter of a buffer.

Parameters

bufferHandle	Handle to the buffer to set the counter for. This buffer must have been created with the StructuredBufferWithCounter bind flag.
sourceBufferHandle	Handle to a buffer to copy the counter value from.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setBufferCounter() [2/2]

virtual void Cogs::IContext::setBufferCounter	(	BufferHandle	bufferHandle,
		uint32_t	value
	)

pure virtual

Set the associated counter of a buffer.

Parameters

bufferHandle	Handle to the buffer to set the counter for. This buffer must have been created with the StructuredBufferWithCounter bind flag.
value	The new value of the counter.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setConstantBuffer() [1/2]

virtual void Cogs::IContext::setConstantBuffer	(	const ConstantBufferBindingHandle	bufferBindingHandle,
		const BufferHandle	bufferHandle,
		const uint32_t	offset = `0`,
		const uint32_t	size = `~0u`
	)

pure virtual

Sets a constant buffer to the given constant buffer binding.

Parameters

bufferBindingHandle	Valid handle to a buffer binding previously created.
bufferHandle	Handle to a buffer created with the BindFlags::ConstantBuffer flag, or NoHandle to remove any existing buffer from the binding.

See also: IEffects::getConstantBufferBinding

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setConstantBuffer() [2/2]

virtual void Cogs::IContext::setConstantBuffer	(	const StringView &	name,
		const BufferHandle	bufferHandle,
		const uint32_t	offset = `0`,
		const uint32_t	size = `~0u`
	)

pure virtual

Sets a constant buffer to be bound to the given name and slot.

Parameters

name	Name of the constant buffer as defined in the shaders.
bufferHandle	Handle to a buffer created with the BindFlags::ConstantBuffer flag, or NoHandle to remove any existing buffer bound.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextCommon.

◆ setDepthStencilState()

virtual void Cogs::IContext::setDepthStencilState ( const DepthStencilStateHandle handle )

pure virtual

Set the current depth stencil state.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setEffect()

virtual void Cogs::IContext::setEffect ( EffectHandle handle )

pure virtual

Set the current effect.

This sets up all shader stages included in the effect (e.g if the effect contains VS and PS shaders both the VS stage and PS stage is set up.

Implemented in Cogs::ContextGL20, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setIndexBuffer()

virtual void Cogs::IContext::setIndexBuffer	(	IndexBufferHandle	bufferHandle,
		uint32_t	stride = `4`,
		uint32_t	offset = `0`
	)

pure virtual

Sets the current index buffer.

Parameters

bufferHandle	Valid handle to an index buffer.
stride	Byte stride of the index data. Currently only supports 2 and 4. Setting stride to zero defaults to the buffers natural stride, if any. If no natural stride is set, no buffer will be bound.
offset	Offset in bytes from the start of the buffer to the first index to use.

Implemented in Cogs::ContextVK, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setInputLayout()

virtual void Cogs::IContext::setInputLayout ( const InputLayoutHandle inputLayoutHandle )

pure virtual

Sets the current input layout.

Parameters

inputLayoutHandle Valid handle to a previously created input layout.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setMatrixVariable() [1/3]

virtual void Cogs::IContext::setMatrixVariable	(	const EffectVariableHandle	variableHandle,
		const float *	value
	)

pure virtual

Sets the given matrix variable to value.

Value must point to a valid 16-element array of floating point values.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setMatrixVariable() [2/3]

virtual void Cogs::IContext::setMatrixVariable	(	const EffectVariableHandle	variableHandle,
		const float *	value,
		size_t	count
	)

pure virtual

Sets the given matrix variable to value.

Value must point to a valid 16-element array of floating point values.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setMatrixVariable() [3/3]

virtual void Cogs::IContext::setMatrixVariable	(	const StringView &	name,
		const float *	value
	)

pure virtual

Sets the matrix variable with the given name in the current effect to value.

Value must point to a 16-element single precision floating point array.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setRasterizerState()

virtual void Cogs::IContext::setRasterizerState ( const RasterizerStateHandle handle )

pure virtual

Set the current rasterizer state.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setRenderTarget()

virtual void Cogs::IContext::setRenderTarget	(	const RenderTargetHandle	handle,
		const DepthStencilHandle	depthStencilHandle
	)

pure virtual

Sets the current render target and an associated depth stencil target.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextWebGPU, and Cogs::ContextNull.

Referenced by Cogs::Core::Renderer::render().

◆ setSamplerState() [1/2]

virtual void Cogs::IContext::setSamplerState	(	const SamplerStateBindingHandle	samplerStateBindingHandle,
		const SamplerStateHandle	samplerStateHandle
	)

pure virtual

Sets the sampler state binding given to the given sampler state.

If the sampler state is set to NoHandle the default sampler state is set for the binding.

Parameters

samplerStateBindingHandle	Valid handle to a previously created sampler state binding object.
samplerStateHandle	Handle to a valid sampler state, or NoHandle to set the default sampler state.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setSamplerState() [2/2]

virtual void Cogs::IContext::setSamplerState	(	const StringView &	name,
		unsigned int	unit,
		SamplerStateHandle	samplerStateHandle
	)

pure virtual

Sets the sampler slot given by unit with the given name to contain the given sampler state.

If the sampler state is set to NoHandle the default sampler state is set.

Parameters

name	Name of the sampler state object as used in shaders (only used where applicable).
unit	Texture unit to bind the sampler state to. The sampler state object is used to sample textures bound to this unit.
samplerStateHandle	Handle to a valid sampler state, or NoHandle to set the default sampler state for the given unit.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextCommon.

◆ setScalarVariable() [1/6]

virtual void Cogs::IContext::setScalarVariable	(	const EffectVariableHandle	variableHandle,
		const float *	value,
		size_t	count
	)

pure virtual

Sets the given scalar integer point variable to the given value.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setScalarVariable() [2/6]

virtual void Cogs::IContext::setScalarVariable	(	const EffectVariableHandle	variableHandle,
		const float	value
	)

pure virtual

Sets the given scalar floating point variable to the given value.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setScalarVariable() [3/6]

virtual void Cogs::IContext::setScalarVariable	(	const EffectVariableHandle	variableHandle,
		const int *	value,
		size_t	count
	)

pure virtual

Sets the given scalar integer point variable to the given value.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setScalarVariable() [4/6]

virtual void Cogs::IContext::setScalarVariable	(	const EffectVariableHandle	variableHandle,
		int	value
	)

pure virtual

Sets the given scalar integer point variable to the given value.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setScalarVariable() [5/6]

virtual void Cogs::IContext::setScalarVariable	(	const StringView &	name,
		const float	value
	)

pure virtual

Sets the scalar floating point variable with the given name to the given value.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setScalarVariable() [6/6]

virtual void Cogs::IContext::setScalarVariable	(	const StringView &	name,
		int	value
	)

pure virtual

Sets the scalar integer variable with the given name to the given value.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setScissor()

virtual void Cogs::IContext::setScissor	(	const int	x,
		const int	y,
		const int	width,
		const int	height
	)

pure virtual

Sets the current scissor rectangle.

Only used if the current rasterizer state enabled scissor testing.

See also: RasterizerState.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setTexture() [1/2]

virtual void Cogs::IContext::setTexture	(	const StringView &	name,
		unsigned int	unit,
		TextureHandle	textureHandle
	)

pure virtual

Sets the texture slot given by unit with the given name to contain the given texture.

If the texture is set to NoHandle the texture slot is cleared.

Parameters

name	Name of the texture object as used in shaders.
unit	Texture unit to bind the texture to.
textureHandle	Handle to a valid texture, or NoHandle to set the default texture binding for the given unit.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextCommon.

◆ setTexture() [2/2]

virtual void Cogs::IContext::setTexture	(	const TextureBindingHandle	textureBindingHandle,
		const TextureHandle	textureHandle
	)

pure virtual

Sets the texture given to the binding given by textureBindingHandle.

Parameters

textureBindingHandle	Valid handle to a previously created texture binding.
textureHandle	Handle to a texture object, or NoHandle to set the default texture to the given binding.

Implemented in Cogs::ContextD3D11, Cogs::ContextGLES30, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextVK, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVariable()

virtual void Cogs::IContext::setVariable	(	const EffectVariableHandle	index,
		const uint8_t *	data,
		size_t	size
	)

pure virtual

Sets the variable with the given name and size.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVector2Variable() [1/2]

virtual void Cogs::IContext::setVector2Variable	(	const EffectVariableHandle	variableHandle,
		const float *	value,
		size_t	count = `1`
	)

pure virtual

Sets the given vector variable to the given two-component value.

Implemented in Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVector2Variable() [2/2]

virtual void Cogs::IContext::setVector2Variable	(	const StringView &	name,
		const float *	value
	)

pure virtual

Sets the vector variable with the given name to the given two-component value.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setVector3Variable() [1/2]

virtual void Cogs::IContext::setVector3Variable	(	const EffectVariableHandle	variableHandle,
		const float *	value,
		size_t	count = `1`
	)

pure virtual

Sets the given vector variable to the given three-component value.

Implemented in Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVector3Variable() [2/2]

virtual void Cogs::IContext::setVector3Variable	(	const StringView &	name,
		const float *	value
	)

pure virtual

Sets the vector variable with the given name to the given three-component value.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setVector4Variable() [1/3]

virtual void Cogs::IContext::setVector4Variable	(	const EffectVariableHandle	variableHandle,
		const float *	value,
		size_t	count = `1`
	)

pure virtual

Sets the given vector variable to the given four-component value.

Implemented in Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVector4Variable() [2/3]

virtual void Cogs::IContext::setVector4Variable	(	const EffectVariableHandle	variableHandle,
		const int *	value,
		size_t	count = `1`
	)

pure virtual

Sets the given vector variable to the given four-component value.

Implemented in Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVector4Variable() [3/3]

virtual void Cogs::IContext::setVector4Variable	(	const StringView &	name,
		const float *	value
	)

pure virtual

Sets the vector variable with the given name to the given four-component value.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextCommon, and Cogs::ContextGLES30.

◆ setVertexArrayObject()

virtual void Cogs::IContext::setVertexArrayObject ( VertexArrayObjectHandle vertexArrayObject )

pure virtual

Sets vertexBuffers and index buffers using a prevalidated vertex array object.

Note: Check capabilites before using this.

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ setVertexBuffers() [1/2]

virtual void Cogs::IContext::setVertexBuffers	(	const VertexBufferHandle *	vertexBufferHandles,
		const size_t	count
	)

pure virtual

Overload provided to support transitioning.

Only supports vertex buffers created with legacy loadVertexBuffer API.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextVK, and Cogs::ContextGLES30.

◆ setVertexBuffers() [2/2]

virtual void Cogs::IContext::setVertexBuffers	(	const VertexBufferHandle *	vertexBufferHandles,
		const size_t	count,
		const uint32_t *	strides,
		const uint32_t *	offsets
	)

pure virtual

Sets the current vertex buffers.

Parameters

vertexBufferHandles	Pointer to an array of vertex buffer handles of size at least count.
count	Number of vertex buffers to bind.
strides	Pointer to array of stride values. Must be non-null and at least of size count.
offsets	Optional pointer to array of offset values. If non-null, must be at least of size count.

Implemented in Cogs::ContextNull, Cogs::ContextWebGPU, Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, and Cogs::ContextVK.

◆ setViewport()

virtual void Cogs::IContext::setViewport	(	const float	x,
		const float	y,
		const float	width,
		const float	height
	)

pure virtual

Sets the current viewport to the given location and dimensions.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ signal()

virtual void Cogs::IContext::signal ( FenceHandle fenceHandle )

pure virtual

Insert a fence in the command stream that will signal when all commands before the fence are completed.

Parameters

fenceHandle The fence to signal.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextCommon, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ unmap() [1/2]

virtual void Cogs::IContext::unmap ( BufferHandle bufferHandle )

pure virtual

Unmaps the given buffer, applying any synchronization necessary to reflect changes in the mapped memory.

Parameters

bufferHandle Valid handle to a buffer that is currently mapped.

See also: map

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

Referenced by Cogs::MappedBuffer< MappedDataType >::~MappedBuffer().

◆ unmap() [2/2]

virtual void Cogs::IContext::unmap ( TextureHandle textureHandle )

pure virtual

Release a host mapping of a staging texture.

Parameters

textureHandle Staging texture that is currently mapped.

Implemented in Cogs::ContextD3D12, Cogs::ContextD3D11, Cogs::ContextVK, Cogs::ContextNull, Cogs::ContextGL20, Cogs::ContextGLES30, and Cogs::ContextWebGPU.

◆ updateBuffer()

virtual void Cogs::IContext::updateBuffer	(	BufferHandle	bufferHandle,
		const void *	data,
		size_t	size
	)

pure virtual

Replace contents of buffer with new data.

This will typically map the buffer + memcpy where this is fast, otherwise it will call buffer update function in underlying api.

The existing contents of the buffer will be invalidated: If provided data is smaller than buffer size, the rest of the buffer is undefined.

See also: map, unmap, updateSubBuffer

Implemented in Cogs::ContextCommon, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ updateSubBuffer()

virtual void Cogs::IContext::updateSubBuffer	(	BufferHandle	bufferHandle,
		const size_t	offset,
		const size_t	size,
		const void *	data
	)

pure virtual

Update a region of data in a buffer.

Parameters

bufferHandle	Valid handle to a buffer to update data in.
offset	Offset in bytes from the start of the buffer to where the new data should be written.
size	Size of the data given. Offset + size must be inside the allocated size of the buffer.
data	Pointer to the data to store at the given offset in the buffer.
invalidate	Invalidate existing buffer contents before updating buffer, i.e. no need to maintain old values.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

◆ updateSubTexture()

virtual void Cogs::IContext::updateSubTexture	(	TextureHandle	textureHandle,
		const size_t	level,
		const void *	data
	)

pure virtual

Update the data of a level in the given texture.

Parameters

textureHandle	Valid handle to a texture to update data in.
level	Index of the mip level to update.
data	Pointer to the data to store in the indicated mip level. Must be sized according to the dimensions, format and mip level.

Implemented in Cogs::ContextD3D11, Cogs::ContextD3D12, Cogs::ContextGL20, Cogs::ContextGLES30, Cogs::ContextVK, Cogs::ContextNull, and Cogs::ContextWebGPU.

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

D:/a/1/s/Cogs/Cogs.Rendering/Source/IContext.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ beginRenderPass()

◆ clearCachedState()

◆ clearDepth()

◆ clearRenderTarget() [1/2]

◆ clearRenderTarget() [2/2]

◆ dispatchCompute()

◆ draw()

◆ drawIndexed()

◆ drawInstanced()

◆ drawInstancedIndexed()

◆ endRenderPass()

◆ getBufferCounter() [1/2]

◆ getBufferCounter() [2/2]

◆ map() [1/2]

◆ map() [2/2]

◆ popCommandGroupAnnotation()

◆ pushCommandGroupAnnotation()

◆ readColorBuffer()

◆ readDepthBuffer()

◆ reset()

◆ resolveResource()

◆ setAnnotationMarker()

◆ setBlendState()

◆ setBuffer() [1/2]

◆ setBuffer() [2/2]

◆ setBufferCounter() [1/2]

◆ setBufferCounter() [2/2]

◆ setConstantBuffer() [1/2]

◆ setConstantBuffer() [2/2]

◆ setDepthStencilState()

◆ setEffect()

◆ setIndexBuffer()

◆ setInputLayout()

◆ setMatrixVariable() [1/3]

◆ setMatrixVariable() [2/3]

◆ setMatrixVariable() [3/3]

◆ setRasterizerState()

◆ setRenderTarget()

◆ setSamplerState() [1/2]

◆ setSamplerState() [2/2]

◆ setScalarVariable() [1/6]

◆ setScalarVariable() [2/6]

◆ setScalarVariable() [3/6]

◆ setScalarVariable() [4/6]

◆ setScalarVariable() [5/6]

◆ setScalarVariable() [6/6]

◆ setScissor()

◆ setTexture() [1/2]

◆ setTexture() [2/2]

◆ setVariable()

◆ setVector2Variable() [1/2]

◆ setVector2Variable() [2/2]

◆ setVector3Variable() [1/2]

◆ setVector3Variable() [2/2]

◆ setVector4Variable() [1/3]

◆ setVector4Variable() [2/3]

◆ setVector4Variable() [3/3]

◆ setVertexArrayObject()

◆ setVertexBuffers() [1/2]

◆ setVertexBuffers() [2/2]

◆ setViewport()

◆ signal()

◆ unmap() [1/2]

◆ unmap() [2/2]

◆ updateBuffer()

◆ updateSubBuffer()

◆ updateSubTexture()