Structure

MTLCommandBufferError

Error codes that indicate why the execution of the command buffer has failed.

Declaration

struct MTLCommandBufferError

Topics

Error Identification

var errorCode: Int

The error code.

var errorUserInfo: [String : Any]

The user info dictionary.

var localizedDescription: String

A string containing the localized description of the error.

Errors

static var timeout: MTLCommandBufferError.Code

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

static var pageFault: MTLCommandBufferError.Code

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

static var blacklisted: MTLCommandBufferError.Code

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

static var notPermitted: MTLCommandBufferError.Code

The process does not have permission to use the Metal device.

static var outOfMemory: MTLCommandBufferError.Code

Insufficient memory was available to execute the command buffer.

static var invalidResource: MTLCommandBufferError.Code

The command buffer referenced an invalid resource.

static var memoryless: MTLCommandBufferError.Code

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

static var deviceRemoved: MTLCommandBufferError.Code

The GPU that executes the commands has been removed.

static var `internal`: MTLCommandBufferError.Code

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

static var errorDomain: String

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

Equality

static func != (MTLCommandBufferError, MTLCommandBufferError) -> Bool

Returns a Boolean value indicating whether two values are not equal.

See Also

Obtaining Status and Timestamps

var status: MTLCommandBufferStatus

The current stage in the lifetime of the command buffer.

Required.

enum MTLCommandBufferStatus

The stages in the lifetime of the command buffer.

var error: Error?

The error that occurred when the command buffer was executed.

Required.

let MTLCommandBufferErrorDomain: String

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

enum MTLCommandBufferError.Code

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

var kernelStartTime: CFTimeInterval

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

Required.

var kernelEndTime: CFTimeInterval

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

Required.

var gpuStartTime: CFTimeInterval

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

Required.

var gpuEndTime: CFTimeInterval

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

Required.