CVPixelBuffer Class

Definition

Namespace:: CoreVideo

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A CVImageBuffer that holds pixels.

public class CVPixelBuffer : CoreVideo.CVImageBuffer

type CVPixelBuffer = class
    inherit CVImageBuffer

Inheritance: Object

DisposableObject

NativeObject

CVBuffer

CVImageBuffer
CVPixelBuffer

Constructors

Name	Description
CVPixelBuffer(IntPtr, IntPtr, CVPixelFormatType, CVPixelBufferAttributes)
CVPixelBuffer(IntPtr, IntPtr, CVPixelFormatType)

Properties

Name	Description
BaseAddress	Pointers to the base address storing the pixels. Must call Lock(CVPixelBufferLock) 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	Get the color space for this image buffer (Inherited from CVImageBuffer)
DataSize
DisplaySize	(Inherited from CVImageBuffer)
EncodedSize	(Inherited from CVImageBuffer)
ExtendedPixelsBottomKey
ExtendedPixelsLeftKey
ExtendedPixelsRightKey
ExtendedPixelsTopKey
Handle	(Inherited from DisposableObject)
Height
HeightKey
IOSurfacePropertiesKey
IOSurfacePurgeableKey	Represents the value associated with the constant 'kCVPixelBufferIOSurfacePurgeableKey'.
IsFlipped	(Inherited from CVImageBuffer)
IsPlanar
MemoryAllocatorKey
MetadataExtension	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_MetadataExtension'.
MetalCompatibilityKey
OpenGLCompatibilityKey
OpenGLESCompatibilityKey
OpenGLESTextureCacheCompatibilityKey
OpenGLTextureCacheCompatibilityKey
Owns	(Inherited from DisposableObject)
PixelFormatType
PixelFormatTypeKey
PlaneAlignmentKey
PlaneCount
ProResRawKey_BlackLevel	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_BlackLevel'.
ProResRawKey_ColorMatrix	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_ColorMatrix'.
ProResRawKey_GainFactor	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_GainFactor'.
ProResRawKey_RecommendedCrop	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_RecommendedCrop'.
ProResRawKey_SenselSitingOffsets	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_SenselSitingOffsets'.
ProResRawKey_WhiteBalanceBlueFactor	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_WhiteBalanceBlueFactor'.
ProResRawKey_WhiteBalanceCct	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_WhiteBalanceCCT'.
ProResRawKey_WhiteBalanceRedFactor	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_WhiteBalanceRedFactor'.
ProResRawKey_WhiteLevel	Represents the value associated with the constant 'kCVPixelBufferProResRAWKey_WhiteLevel'.
VersatileBayerKey_BayerPattern	Represents the value associated with the constant 'kCVPixelBufferVersatileBayerKey_BayerPattern'.
Width
WidthKey

Methods

Name	Description
ClearHandle()	(Inherited from DisposableObject)
Create(IntPtr, IntPtr, CVPixelFormatType, Byte[], IntPtr, CVPixelBufferAttributes, CVReturn)
Create(IntPtr, IntPtr, CVPixelFormatType, Byte[], IntPtr, CVPixelBufferAttributes)
Create(IntPtr, IntPtr, CVPixelFormatType, Byte[][], IntPtr[], IntPtr[], IntPtr[], CVPixelBufferAttributes, CVReturn)
Create(IntPtr, IntPtr, CVPixelFormatType, Byte[][], IntPtr[], IntPtr[], IntPtr[], CVPixelBufferAttributes)
Create(IOSurface, CVPixelBufferAttributes)
Create(IOSurface, CVReturn, CVPixelBufferAttributes)
Dispose()	(Inherited from DisposableObject)
Dispose(Boolean)	(Inherited from NativeObject)
Equals(Object)	(Inherited from DisposableObject)
FillExtendedPixels()
GetAttachment(NSString, CVAttachmentMode)	Obsolete. (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(IntPtr)
GetBytesPerRowOfPlane(IntPtr)
GetCheckedHandle()	(Inherited from DisposableObject)
GetExtendedPixels(UIntPtr, UIntPtr, UIntPtr, UIntPtr)
GetHashCode()	(Inherited from DisposableObject)
GetHeightOfPlane(IntPtr)
GetIOSurface()
GetPixelBufferCreationAttributes()
GetTypeID()	Type identifier for the CoreVideo.CVPixelBuffer type.
GetWidthOfPlane(IntPtr)
HasAttachment(NSString)	(Inherited from CVBuffer)
InitializeHandle(NativeHandle)	(Inherited from DisposableObject)
IsCompatibleWithAttributes(CVPixelBufferAttributes)	Check if this pixel buffer is compatible with the specified pixel buffer attributes.
IsCompatibleWithAttributes(NSDictionary)	Check if this pixel buffer is compatible with the specified pixel buffer attributes.
Lock(CVPixelBufferLock)	Locks the storage for the pixel buffer.
PropogateAttachments(CVBuffer)	(Inherited from CVBuffer)
Release()	(Inherited from CVBuffer)
RemoveAllAttachments()	(Inherited from CVBuffer)
RemoveAttachment(NSString)	(Inherited from CVBuffer)
Retain()	(Inherited from CVBuffer)
SetAttachment(NSString, INativeObject, CVAttachmentMode)	(Inherited from CVBuffer)
SetAttachments(NSDictionary, CVAttachmentMode)	(Inherited from CVBuffer)
Unlock(CVPixelBufferLock)

Extension Methods

Name	Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
ToCGImage(CVPixelBuffer, CGImage)

Applies to

Share via