apple.metal.protocol

Interface MTLCommandEncoder

All Known Subinterfaces:

MTLAccelerationStructureCommandEncoder, MTLBlitCommandEncoder, MTLComputeCommandEncoder, MTLParallelRenderCommandEncoder, MTLRenderCommandEncoder, MTLResourceStateCommandEncoder

public interface MTLCommandEncoder

[@protocol] MTLCommandEncoder

MTLCommandEncoder is the common interface for objects that write commands into MTLCommandBuffers.

Method Summary

Modifier and Type	Method and Description
MTLDevice	device() [@property] device
void	endEncoding() endEncoding
void	insertDebugSignpost(java.lang.String string) insertDebugSignpost:
java.lang.String	label() [@property] label
void	popDebugGroup() popDebugGroup
void	pushDebugGroup(java.lang.String string) pushDebugGroup:
void	setLabel(java.lang.String value) [@property] label

Method Detail

device

MTLDevice device()

[@property] device

The device this resource was created against.

endEncoding

void endEncoding()

endEncoding

Declare that all command generation from this encoder is complete, and detach from the MTLCommandBuffer.

insertDebugSignpost

void insertDebugSignpost(java.lang.String string)

insertDebugSignpost:

Inserts a debug string into the command buffer. This does not change any API behavior, but can be useful when debugging.

label

java.lang.String label()

[@property] label

A string to help identify this object.

popDebugGroup

void popDebugGroup()

popDebugGroup

Pop the latest named string off of the stack.

pushDebugGroup

void pushDebugGroup(java.lang.String string)

pushDebugGroup:

Push a new named string onto a stack of string labels.

setLabel

void setLabel(java.lang.String value)

[@property] label

A string to help identify this object.