Class

MTLHeapDescriptor

An object you use to configure new heap objects.

Declaration

@interface MTLHeapDescriptor : NSObject

Overview

To create a new MTLHeap, first create a MTLHeapDescriptor object and set its property values. Then, call the newHeapWithDescriptor: method of a MTLDevice object.

When you create a heap, Metal copies the descriptor’s property values into the new heap. You can reuse a MTLHeapDescriptor object, modifying its property values as needed, to create more MTLHeap objects.

Topics

Specifying Heap Attributes

type

The type of heap to create.

storageMode

The storage mode for the heap.

cpuCacheMode

The CPU cache mode for the heap.

hazardTrackingMode

The heap's hazard tracking mode.

resourceOptions

The options for all the resources you create on the heap.

size

The size of the heap, in bytes.

MTLHazardTrackingMode

The options you use to specify the hazard tracking mode.

MTLHeapType

The options you use to choose the heap type.

Relationships

Inherits From

Conforms To

See Also

Essentials

Image Filter Graph with Heaps and Fences

Demonstrates how to use heaps and fences to optimize a multistage image filter.

MTLHeap

A memory pool from which you can suballocate resources.

MTLSizeAndAlign

The size and alignment of a resource, in bytes.