Store encoded commands for the GPU to execute. More...

Inherits CommandBuffer.

Public Member Functions
Constructor, Destructor and Initializers
	CommandBufferMTL (DeviceMTL *deviceMTL)

	~CommandBufferMTL ()

Public Member Functions inherited from CommandBuffer
void	setStencilReferenceValue (unsigned int value)
	Update both front and back stencil reference value.

void	setStencilReferenceValue (unsigned int frontRef, unsigned int backRef)
	Update stencil reference value.

Setters & Getters
virtual void	beginFrame () override
	Indicate the begining of a frame Wait until the inflight command buffer has completed its work.

virtual void	beginRenderPass (const RenderPassDescriptor &descriptor) override
	Create a MTLRenderCommandEncoder object for graphics rendering to an attachment in a RenderPassDescriptor.

virtual void	setRenderPipeline (RenderPipeline *renderPipeline) override
	Sets the current render pipeline state object.

virtual void	setViewport (int x, int y, unsigned int w, unsigned int h) override
	Fixed-function state.

virtual void	setCullMode (CullMode mode) override
	Fixed-function state.

virtual void	setWinding (Winding winding) override
	Fixed-function state.

virtual void	setVertexBuffer (Buffer *buffer) override
	Set a global buffer for all vertex shaders at the given bind point index 0.

virtual void	setProgramState (ProgramState *programState) override
	Set the uniform data at a given vertex and fragment buffer binding point 1 Set a global texture for all vertex and fragment shaders at the given bind location.

virtual void	setIndexBuffer (Buffer *buffer) override
	Set indexes when drawing primitives with index list @ buffer A buffer object that the device will read indexes from.

virtual void	drawArrays (PrimitiveType primitiveType, std::size_t start, std::size_t count) override
	Draw primitives without an index list.

virtual void	drawElements (PrimitiveType primitiveType, IndexFormat indexType, std::size_t count, std::size_t offset) override
	Draw primitives with an index list.

virtual void	endRenderPass () override
	Do some resources release.

virtual void	endFrame () override
	Present a drawable and commit a command buffer so it can be executed as soon as possible.

virtual void	setLineWidth (float lineWidth) override
	Fixed-function state.

virtual void	setScissorRect (bool isEnabled, float x, float y, float width, float height) override
	Fixed-function state.

virtual void	setDepthStencilState (DepthStencilState *depthStencilState) override
	Set depthStencil status.

virtual void	captureScreen (std::function< void(const unsigned char *, int, int)> callback) override
	Get a screen snapshot.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

Store encoded commands for the GPU to execute.

A command buffer stores encoded commands until the buffer is committed for execution by the GPU

Constructor & Destructor Documentation

CommandBufferMTL ( DeviceMTL * deviceMTL )

Parameters

deviceMTL The device for which MTLCommandQueue object was created.

Member Function Documentation

virtual void beginFrame ( )

overridevirtual

Indicate the begining of a frame Wait until the inflight command buffer has completed its work.

Then create MTLCommandBuffer and enqueue it to MTLCommandQueue. Then start schedule available MTLBuffer

Implements CommandBuffer.

virtual void beginRenderPass ( const RenderPassDescriptor & descriptor )

overridevirtual

Create a MTLRenderCommandEncoder object for graphics rendering to an attachment in a RenderPassDescriptor.

MTLRenderCommandEncoder is cached if current RenderPassDescriptor is identical to previous one.

Parameters

descriptor Specifies a group of render targets that hold the results of a render pass.

Implements CommandBuffer.

virtual void setRenderPipeline ( RenderPipeline * renderPipeline )

overridevirtual

Sets the current render pipeline state object.

Parameters

renderPipeline An object that contains the graphics functions and configuration state used in a render pass.

Implements CommandBuffer.

virtual void setViewport	(	int	x,
		int	y,
		unsigned int	w,
		unsigned int	h
	)

overridevirtual

Fixed-function state.

Parameters

x	The x coordinate of the upper-left corner of the viewport.
y	The y coordinate of the upper-left corner of the viewport.
w	The width of the viewport, in pixels.
h	The height of the viewport, in pixels.

Implements CommandBuffer.

virtual void setCullMode ( CullMode mode )

overridevirtual

Fixed-function state.

Parameters

mode	Controls if primitives are culled when front facing, back facing, or not culled at all.

Implements CommandBuffer.

virtual void setWinding ( Winding winding )

overridevirtual

Fixed-function state.

Parameters

winding The winding order of front-facing primitives.

Implements CommandBuffer.

virtual void setVertexBuffer ( Buffer * buffer )

overridevirtual

Set a global buffer for all vertex shaders at the given bind point index 0.

Parameters

buffer The buffer to set in the buffer argument table.

Implements CommandBuffer.

virtual void setProgramState ( ProgramState * programState )

overridevirtual

Set the uniform data at a given vertex and fragment buffer binding point 1 Set a global texture for all vertex and fragment shaders at the given bind location.

Parameters

programState A programState object that hold the uniform and texture data.

Implements CommandBuffer.

virtual void setIndexBuffer ( Buffer * buffer )

overridevirtual

Set indexes when drawing primitives with index list @ buffer A buffer object that the device will read indexes from.

@ see drawElements(PrimitiveType primitiveType, IndexFormat indexType, unsigned int count, unsigned int offset)

Implements CommandBuffer.

virtual void drawArrays	(	PrimitiveType	primitiveType,
		std::size_t	start,
		std::size_t	count
	)

overridevirtual

Draw primitives without an index list.

Parameters

primitiveType	The type of primitives that elements are assembled into.
start	For each instance, the first index to draw
count	For each instance, the number of indexes to draw

See Also: drawElements(PrimitiveType primitiveType, IndexFormat indexType, unsigned int count, unsigned int offset)

Implements CommandBuffer.

virtual void drawElements	(	PrimitiveType	primitiveType,
		IndexFormat	indexType,
		std::size_t	count,
		std::size_t	offset
	)

overridevirtual

Draw primitives with an index list.

Parameters

primitiveType	The type of primitives that elements are assembled into.
indexType	The type if indexes, either 16 bit integer or 32 bit integer.
count	The number of indexes to read from the index buffer for each instance.
offset	Byte offset within indexBuffer to start reading indexes from.