Struct CVMetalBufferCache

Source

pub struct CVMetalBufferCache { /* private fields */ }

Available on crate feature CVMetalBufferCache only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CVMetalBufferCache

Source

pub unsafe fn create( allocator: Option<&CFAllocator>, cache_attributes: Option<&CFDictionary>, metal_device: &ProtocolObject<dyn MTLDevice>, cache_out: NonNull<*mut CVMetalBufferCache>, ) -> CVReturn

Available on crate feature CVReturn and crate feature objc2 and crate feature objc2-metal and non-watchOS only.

Creates a new Buffer Cache.

Parameter allocator: The CFAllocatorRef to use for allocating the cache. May be NULL.

Parameter cacheAttributes: A CFDictionaryRef containing the attributes of the cache itself. May be NULL.

Parameter metalDevice: The Metal device for which the buffer objects will be created.

Parameter cacheOut: The newly created buffer cache will be placed here

Returns: Returns kCVReturnSuccess on success

§Safety

cache_attributes generics must be of the correct type.
cache_out must be a valid pointer.

Source

pub unsafe fn create_buffer_from_image( allocator: Option<&CFAllocator>, buffer_cache: &CVMetalBufferCache, image_buffer: &CVImageBuffer, buffer_out: NonNull<*mut CVMetalBuffer>, ) -> CVReturn

Available on crate features CVBuffer and CVImageBuffer and CVMetalBuffer and CVReturn only.

Creates a CVMetalBuffer object from an existing CVImageBuffer

Parameter allocator: The CFAllocatorRef to use for allocating the CVMetalBuffer object. May be NULL.

Parameter bufferCache: The buffer cache object that will manage the buffer.

Parameter buffer: The CVImageBuffer that you want to create a CVMetalBuffer from.

Parameter bufferOut: The newly created buffer object will be placed here.

Returns: Returns kCVReturnSuccess on success

Creates or returns a cached CVMetalBuffer object mapped to the CVImageBuffer. This creates a live binding between the CVImageBuffer and underlying CVMetalBuffer buffer object.

IMPORTANT NOTE: Clients should retain CVMetalBuffer objects until they are done using the images in them. Retaining a CVMetalBuffer is your way to indicate that you’re still using the image in the buffer, and that it should not be recycled yet.

§Safety

buffer_out must be a valid pointer.

Source

pub fn flush(&self, options: CVOptionFlags)

Available on crate feature CVBase only.

Performs internal housekeeping/recycling operations

This call must be made periodically to give the buffer cache a chance to do internal housekeeping operations.

Parameter bufferCache: The buffer cache object to flush

Parameter options: Currently unused, set to 0.

Methods from Deref<Target = CFType>§

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

Source

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.