Enumeration

MTLCommandBufferError

Error codes that indicate why the execution of the command buffer has failed. The error property contains the error code.

Declaration

typedef enum MTLCommandBufferError : NSUInteger {
    ...
} MTLCommandBufferError;

Topics

Constants

MTLCommandBufferErrorNone

No error occurred.

MTLCommandBufferErrorInternal

An internal error that doesn't fit into the other categories.

MTLCommandBufferErrorTimeout

Execution of this command buffer took more time than the system allows, so execution was interrupted and aborted.

MTLCommandBufferErrorPageFault

Execution of this command buffer generated an unserviceable GPU page fault.

MTLCommandBufferErrorBlacklisted

Access to this device has been revoked because this client has been responsible for too many timeouts or hangs.

MTLCommandBufferErrorNotPermitted

This process does not have access to use this device.

MTLCommandBufferErrorOutOfMemory

Insufficient memory was available to execute this command buffer.

MTLCommandBufferErrorInvalidResource

The command buffer referenced an invalid resource.

MTLCommandBufferErrorMemoryless

One or more internal resource limits was reached that prevent using memoryless render pass attachments.

MTLCommandBufferErrorDeviceRemoved

The device was physically removed before the command could finish execution.

See Also

Obtaining Status and Timestamps

status

The current stage in the lifetime of the command buffer.

Required.

MTLCommandBufferStatus

The stages in the lifetime of the command buffer.

error

The error that occurred when the command buffer was executed.

Required.

MTLCommandBufferErrorDomain

The error domain used by MTLCommandBuffer when returning command buffer execution errors.

kernelStartTime

The host time, in seconds, when the CPU began scheduling this command buffer for execution.

Required.

kernelEndTime

The host time, in seconds, when the CPU finished scheduling this command buffer for execution.

Required.

GPUStartTime

The host time, in seconds, when the GPU began executing this command buffer.

Required.

GPUEndTime

The host time, in seconds, when the GPU finished executing this command buffer.

Required.