CVPixelBufferMBS properties

Online Documentation   -   Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchy

New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1

The list of the   topics,   classes,   interfaces,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Back to CVPixelBufferMBS class.

CVPixelBufferMBS.BaseAddress as Ptr

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the base address of the pixel buffer.

For chunky buffers, returns a pointer to the pixel at (0,0) in the buffer.
For planar buffers, returns a pointer to a PlanarComponentInfo structure (as defined by QuickTime in ImageCodec.h).

Retrieving the base address for a pixel buffer requires that the buffer base address be locked via a successful call to CVPixelBufferLockBaseAddress.
(Read only property)

CVPixelBufferMBS.BytesPerRow as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the number of bytes per row of the pixel buffer.
Example
dim p as new Picture(300, 200)
dim b as new CVPixelBufferMBS(p)
MsgBox str(b.BytesPerRow)

The number of bytes per row of the image data. For planar buffers, this function returns a rowBytes value such that bytesPerRow * height covers the entire image, including all planes.
(Read only property)

CVPixelBufferMBS.DataSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the data size for contiguous planes of the pixel buffer.
Example
dim p as new Picture(300, 200)
dim b as new CVPixelBufferMBS(p)
MsgBox str(b.DataSize)

(Read only property)

CVPixelBufferMBS.Height as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the height of the pixel buffer.
Example
dim p as new Picture(300, 200)
dim b as CVPixelBufferMBS = CVPixelBufferMBS.PixelBufferWithPicture(p)
MsgBox str(b.Width)+" x "+str(b.Height)

(Read only property)

CVPixelBufferMBS.IsPlanar as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Determines whether the pixel buffer is planar.

Returns true if the pixel buffer was created using CVPixelBufferCreateWithPlanarBytes; otherwise, false.
(Read only property)

CVPixelBufferMBS.PixelFormatType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the pixel format type of the pixel buffer.

Returns a four-character code OSType identifier for the pixel format.
(Read only property)

CVPixelBufferMBS.PlaneCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns number of planes of the pixel buffer.

Returns the number of planes. Returns 0 for nonplanar pixel buffers.
(Read only property)

CVPixelBufferMBS.Width as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the width of the pixel buffer.
Example
dim p as new Picture(300, 200)
dim b as CVPixelBufferMBS = CVPixelBufferMBS.PixelBufferWithPicture(p)
MsgBox str(b.Width)+" x "+str(b.Height)

(Read only property)

The items on this page are in the following plugins: MBS AVFoundation Plugin.


💬 Ask a question or report a problem