IOSurface Functions

No overview available.

Topics

Functions

IOSurfaceAlignProperty

Returns the smallest aligned value greater than or equal to the specified value.

IOSurfaceCopyValue

Retrieves a value from the dictionary associated with the buffer.

IOSurfaceCreate

Creates a brand new IOSurface object

IOSurfaceCreateMachPort

Returns a mach_port_t that holds a reference to the IOSurface.

IOSurfaceCreateXPCObject

Returns an xpc_object_t that holds a reference to the IOSurface.

IOSurfaceDecrementUseCount

Decrements the per-process usage count for an IOSurface.

IOSurfaceGetAllocSize

Returns the total allocation size of the buffer including all planes.

IOSurfaceGetBaseAddress

Returns the address of the first byte of data in a particular buffer.

IOSurfaceGetBaseAddressOfPlane

Returns the address of the first byte of data in the specified plane.

IOSurfaceGetBytesPerElement

Returns the length (in bytes) of each element in a particular buffer.

IOSurfaceGetBytesPerElementOfPlane

Returns the size of each element (in bytes) in the specified plane.

IOSurfaceGetBytesPerRow

Returns the length (in bytes) of each row in a particular buffer.

IOSurfaceGetBytesPerRowOfPlane

Returns the size of each row (in bytes) in the specified plane.

IOSurfaceGetElementHeight

Returns the height (in pixels) of each element in a particular buffer.

IOSurfaceGetElementHeightOfPlane

Returns the height (in pixels) of each element in the specified plane.

IOSurfaceGetElementWidth

Returns the width (in pixels) of each element in a particular buffer.

IOSurfaceGetElementWidthOfPlane

Returns the width (in pixels) of each element in the specified plane.

IOSurfaceGetHeight

Returns the height of the IOSurface buffer in pixels.

IOSurfaceGetHeightOfPlane

Returns the height of the specified plane (in pixels).

IOSurfaceGetID

Retrieves the unique IOSurfaceID value for an IOSurface.

IOSurfaceGetPixelFormat

Returns an unsigned integer that contains the traditional macOS buffer format.

IOSurfaceGetPropertyAlignment

Returns the alignment requirements for a property (if any).

IOSurfaceGetPropertyMaximum

Returns the maximum value for a given property that is guaranteed to be compatible with all of the current devices (GPUs, etc.) in the system.

IOSurfaceGetUseCount

Returns the per-process usage count for an IOSurface.

IOSurfaceGetWidth

Returns the width of the IOSurface buffer in pixels.

IOSurfaceGetWidthOfPlane

Returns the width of the specified plane (in pixels).

IOSurfaceIncrementUseCount

Increments the per-process usage count for an IOSurface.

IOSurfaceIsInUse

Returns true of an IOSurface is in use by any process in the system, otherwise false.

IOSurfaceLock

“Lock” an IOSurface for reading or writing.

IOSurfaceLookup

Performs an atomic lookup and retain of an IOSurface by its IOSurfaceID.

IOSurfaceLookupFromMachPort

Recreates an IOSurfaceRef from a mach port.

IOSurfaceRemoveValue

Deletes a value in the dictionary associated with the buffer.

IOSurfaceSetValue

Sets a value in the dictionary associated with the buffer.

IOSurfaceUnlock

“Unlock” an IOSurface for reading or writing.