CVPixelBuffer Class

  • Reference

Definition

Namespace:
CoreVideo
Assembly:
Xamarin.iOS.dll
Assembly:
Xamarin.Mac.dll

A CVImageBuffer that holds pixels.

[ObjCRuntime.Watch(4, 0)]
public class CVPixelBuffer : CoreVideo.CVImageBuffer
type CVPixelBuffer = class
    inherit CVImageBuffer
Inheritance
Object
CVBuffer
CVImageBuffer
CVPixelBuffer
Attributes
WatchAttribute

Constructors

CVPixelBuffer(nint, nint, CVPixelFormatType, CVPixelBufferAttributes)
CVPixelBuffer(nint, nint, CVPixelFormatType)

Properties

BaseAddress

Pointers to the base address storing the pixels.   Must call M:CoreVideo.CVPixelBuffer.Lock* to to lock the base address
BytesPerRow

The number of bytes per row in the pixel buffer.
BytesPerRowAlignmentKey
CGBitmapContextCompatibilityKey
CGImageCompatibilityKey
CleanRect (Inherited from CVImageBuffer)
ColorSpace

Developers should not use this deprecated property.

(Inherited from CVImageBuffer)
DataSize
DisplaySize (Inherited from CVImageBuffer)
EncodedSize (Inherited from CVImageBuffer)
ExtendedPixelsBottomKey
ExtendedPixelsLeftKey
ExtendedPixelsRightKey
ExtendedPixelsTopKey
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from CVBuffer)
Height
HeightKey
IOSurfacePropertiesKey
IsFlipped (Inherited from CVImageBuffer)
IsPlanar
MemoryAllocatorKey
MetalCompatibilityKey
OpenGLCompatibilityKey
OpenGLESCompatibilityKey
OpenGLESTextureCacheCompatibilityKey
OpenGLTextureCacheCompatibilityKey
PixelFormatType
PixelFormatTypeKey
PlaneAlignmentKey
PlaneCount
Width
WidthKey

Methods

Create(IOSurface, CVPixelBufferAttributes)
Create(IOSurface, CVReturn, CVPixelBufferAttributes)
Create(nint, nint, CVPixelFormatType, Byte[], nint, CVPixelBufferAttributes, CVReturn)
Create(nint, nint, CVPixelFormatType, Byte[], nint, CVPixelBufferAttributes)
Create(nint, nint, CVPixelFormatType, Byte[][], nint[], nint[], nint[], CVPixelBufferAttributes, CVReturn)
Create(nint, nint, CVPixelFormatType, Byte[][], nint[], nint[], nint[], CVPixelBufferAttributes)
Dispose()

Releases the resources used by the CVBuffer object.

(Inherited from CVBuffer)
Dispose(Boolean)

Releases the resources used by the CVBuffer object.

(Inherited from CVBuffer)
FillExtendedPixels()
GetAttachment(NSString, CVAttachmentMode) (Inherited from CVBuffer)
GetAttachment<T>(NSString, CVAttachmentMode) (Inherited from CVBuffer)
GetAttachments(CVAttachmentMode) (Inherited from CVBuffer)
GetAttachments<TKey,TValue>(CVAttachmentMode) (Inherited from CVBuffer)
GetAttributes(NSDictionary[])
GetBaseAddress(nint)
GetBytesPerRowOfPlane(nint)
GetExtendedPixels(nuint, nuint, nuint, nuint)
GetHeightOfPlane(nint)
GetIOSurface()
GetTypeID()

Type identifier for the CoreVideo.CVPixelBuffer type.
GetWidthOfPlane(nint)
Lock(CVOptionFlags)
Obsolete.

Locks the storage for the pixel buffer.
Lock(CVPixelBufferLock)
PropogateAttachments(CVBuffer) (Inherited from CVBuffer)
RemoveAllAttachments() (Inherited from CVBuffer)
RemoveAttachment(NSString) (Inherited from CVBuffer)
SetAttachment(NSString, INativeObject, CVAttachmentMode) (Inherited from CVBuffer)
SetAttachments(NSDictionary, CVAttachmentMode) (Inherited from CVBuffer)
Unlock(CVOptionFlags)
Unlock(CVPixelBufferLock)

Extension Methods

ToCGImage(CVPixelBuffer, CGImage)

Applies to

See also