A texture for use in convolutional neural networks that stores transient data to be used and discarded promptly.
- iOS 10.0+
- macOS 10.13+
- Mac Catalyst 13.0+Beta
- tvOS 10.0+
- Metal Performance Shaders
MPSTemporary objects can provide a profound reduction in the aggregate texture memory and associated CPU-side allocation cost in your app. Metal Performance Shaders achieves this by automatically identifying
MPSTemporary objects that do not overlap in time over the course of a
MTLCommand object’s lifetime and can therefore reuse the same memory.
MPSTemporary objects leverage an internal cache of preallocated reusable memory to hold pixel data to avoid typical memory allocation performance penalties common to ordinary
To avoid data corruption due to aliasing,
MPSTemporary objects impose some important restrictions:
The underlying texture storage mode is
MTLStorage. You cannot, for example, use the
Bytes(_: bytes Per Row: from: mipmap Level:)
replace(region:methods with them. Temporary images are strictly read and written by the GPU.
mipmap Level: with Bytes: bytes Per Row:)
The temporary image may be used only on a single
MTLCommandobject. This limits the chronology to a single linear time stream.
readproperty must be managed correctly.
Temporary images must also adhere to the general pixel format restrictions for
Since temporary images can only be used with a single command buffer, and can not be used off the GPU, they generally should not be kept around past the completion of their associated command buffer. The lifetime of a temporary image is typically expected to be extremely short, perhaps spanning only a few lines of code.
To keep the lifetime of the underlying texture allocation as short as possible, the texture is not allocated until the first time the
MPSTemporary object is used by an MPSCNNKernel object or until the first time the
texture property is read. The
read property serves to limit the lifetime of the texture on deallocation.
You may use the
texture property with the
encode methods of an
MPSUnary subclass, if
feature and the texture conforms to the requirements of the given kernel. In such cases, the
read property is not modified, since the enclosing object is not available. There is no locking mechanism provided to prevent a
MTLTexture object returned from the
texture property from becoming invalid when the value of the
read property reaches 0.
MPSTemporary objects can otherwise be used wherever
MPSImage objects are used.
The MPSTemporaryImage Class
MPSTemporary class extends the
MPSImage class to provide advanced caching of unused memory, in order to increase performance and reduce memory footprint.
MPSTemporary objects are intended as fast GPU-only storage for intermediate image data needed only transiently within a single
MTLCommand object. They accelerate the common case of image data which is created only to be consumed and destroyed immediately by the next operation(s) encoded in a command buffer.
MPSTemporary objects provide a convenient and simple way to save memory by automatically aliasing other
MPSTemporary objects in the same command buffer. Because they alias (i.e., share texel storage with) other textures in the same command buffer, the valid lifetime of the data in an
MPSTemporary object is extremely short, limited to a portion of a the command buffer itself.