Platforms to show: All Mac Windows Linux Cross-Platform
Back to CVPixelBufferMBS class.
CVPixelBufferMBS.kCVPixelBufferBytesPerRowAlignmentKey as string
Function:
One of the attribute keys.
Notes: Indicates the number of bytes per row in the pixel buffer (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Indicates the number of bytes per row in the pixel buffer (type Number).
CVPixelBufferMBS.kCVPixelBufferCGBitmapContextCompatibilityKey as string
Function:
One of the attribute keys.
Notes: Indicates whether the pixel buffer is compatible with Core Graphics bitmap contexts (type Boolean).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Indicates whether the pixel buffer is compatible with Core Graphics bitmap contexts (type Boolean).
Some examples using this method:
CVPixelBufferMBS.kCVPixelBufferCGImageCompatibilityKey as string
Function:
One of the attribute keys.
Notes: Indicates whether the pixel buffer is compatible with CGImage types (type Boolean).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Indicates whether the pixel buffer is compatible with CGImage types (type Boolean).
Some examples using this method:
CVPixelBufferMBS.kCVPixelBufferExtendedPixelsBottomKey as string
Function:
One of the attribute keys.
Notes: The number of pixels padding the bottom of the image (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The number of pixels padding the bottom of the image (type Number).
CVPixelBufferMBS.kCVPixelBufferExtendedPixelsLeftKey as string
Function:
One of the attribute keys.
Notes: The number of pixels padding the left of the image (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The number of pixels padding the left of the image (type Number).
CVPixelBufferMBS.kCVPixelBufferExtendedPixelsRightKey as string
Function:
One of the attribute keys.
Notes: The number of pixels padding the right of the image (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The number of pixels padding the right of the image (type Number).
CVPixelBufferMBS.kCVPixelBufferExtendedPixelsTopKey as string
Function:
One of the attribute keys.
Notes: The number of pixels padding the top of the image (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The number of pixels padding the top of the image (type Number).
CVPixelBufferMBS.kCVPixelBufferHeightKey as string
Function:
One of the attribute keys.
Notes: The height of the pixel buffer (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The height of the pixel buffer (type Number).
Some examples using this method:
CVPixelBufferMBS.kCVPixelBufferIOSurfaceCoreAnimationCompatibilityKey as string
Function:
One of the attribute keys.
Notes: A boolean value
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: A boolean value
CVPixelBufferMBS.kCVPixelBufferIOSurfaceOpenGLFBOCompatibilityKey as string
Function:
One of the attribute keys.
Notes: Ensures that the CVPixelBuffer's IOSurfaceRef can be displayed in an CoreAnimation CALayer.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Ensures that the CVPixelBuffer's IOSurfaceRef can be displayed in an CoreAnimation CALayer.
CVPixelBufferMBS.kCVPixelBufferIOSurfaceOpenGLTextureCompatibilityKey as string
Function:
One of the attribute keys.
Notes: Ensures that CGLTexImageIOSurface2D() will succeed in creating a valid texture object from the CVPixelBuffer's IOSurface AND that the resulting texture may be used as a color buffer attachment to a OpenGL frame buffer object.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Ensures that CGLTexImageIOSurface2D() will succeed in creating a valid texture object from the CVPixelBuffer's IOSurface AND that the resulting texture may be used as a color buffer attachment to a OpenGL frame buffer object.
CVPixelBufferMBS.kCVPixelBufferIOSurfacePropertiesKey as string
Function:
One of the attribute keys.
Notes:
Indicates optional properties in the IOSurface framework (type Dictionary). An empty dictionary indicates default values.
Presence of this key requests allocation via the IOSurface framework.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
Indicates optional properties in the IOSurface framework (type Dictionary). An empty dictionary indicates default values.
Presence of this key requests allocation via the IOSurface framework.
CVPixelBufferMBS.kCVPixelBufferMemoryAllocatorKey as string
Function:
One of the attribute keys.
Notes: The allocator used with this buffer (type CFAllocatorRef).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The allocator used with this buffer (type CFAllocatorRef).
CVPixelBufferMBS.kCVPixelBufferOpenGLCompatibilityKey as string
Function:
One of the attribute keys.
Notes: Indicates whether the pixel buffer is compatible with Core Graphics bitmap contexts (type Boolean).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Indicates whether the pixel buffer is compatible with Core Graphics bitmap contexts (type Boolean).
CVPixelBufferMBS.kCVPixelBufferPixelFormatTypeKey as string
Function:
One of the attribute keys.
Notes: The pixel format for this buffer (type Number, or type Array containing an array of Number types (actually type OSType)). For a listing of common pixel formats, see the QuickTime Ice Floe Dispatch 20.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The pixel format for this buffer (type Number, or type Array containing an array of Number types (actually type OSType)). For a listing of common pixel formats, see the QuickTime Ice Floe Dispatch 20.
Some examples using this method:
CVPixelBufferMBS.kCVPixelBufferPlaneAlignmentKey as string
Function:
One of the attribute keys.
Notes: Specifies the alignment of the planes within the buffer. Planes will start on a byte number which is a multiple of this value. (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Specifies the alignment of the planes within the buffer. Planes will start on a byte number which is a multiple of this value. (type Number).
CVPixelBufferMBS.kCVPixelBufferWidthKey as string
Function:
One of the attribute keys.
Notes: The width of the pixel buffer (type Number).
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The width of the pixel buffer (type Number).
Some examples using this method:
CVPixelBufferMBS.PixelBufferWithCGImage(CGImage as Variant) as CVPixelBufferMBS
Function:
Creates a pixel buffer for a CGImage by making a copy of the picture.
Notes:
Image parameter must be a CGImageMBS object.
For Carbon and Cocoa.
Returns nil on any error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
Image parameter must be a CGImageMBS object.
For Carbon and Cocoa.
Returns nil on any error.
CVPixelBufferMBS.PixelBufferWithHandle(Handle as Integer) as CVPixelBufferMBS
Function:
Creates pixel buffer object with handle.
Notes: Handle must be a CVPixelBufferRef, which we retain.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 19.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: Handle must be a CVPixelBufferRef, which we retain.
CVPixelBufferMBS.PixelBufferWithPicture(pic as picture) as CVPixelBufferMBS
Function:
Creates a pixel buffer for a picture by making a copy of the picture.
Example:
Notes:
For Carbon and Cocoa.
Returns nil on any error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | AVFoundation | MBS AVFoundation Plugin | 13.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim p as new Picture(300, 200)
dim b as CVPixelBufferMBS = CVPixelBufferMBS.PixelBufferWithPicture(p)
MsgBox str(b.Width)+" x "+str(b.Height)
For Carbon and Cocoa.
Returns nil on any error.
The items on this page are in the following plugins: MBS AVFoundation Plugin.
