Accelerate · IOS API REFERENCE

vImageCVImageFormat

class · SDK 27.1

class vImageCVImageFormat

Members (13)

get · iOS 13.0+

colorSpace

TypeScript

get colorSpace(): (_CoreGraphics_CGColorSpace) | null

Swift declaration

var colorSpace: CGColorSpace? { get set }

The color space of a Core Video image format.

set · iOS 13.0+

colorSpace

TypeScript

set colorSpace(value: (_CoreGraphics_CGColorSpace) | null)

Swift declaration

var colorSpace: CGColorSpace? { get set }

The color space of a Core Video image format.

get · iOS 13.0+

formatCode

TypeScript

get formatCode(): number

Swift declaration

var formatCode: UInt32 { get }

The format code of a Core Video image format.

get · iOS 13.0+

channelCount

TypeScript

get channelCount(): number

Swift declaration

var channelCount: UInt32 { get }

The number of channels, including alpha, for the Core Video image format.

get · iOS 13.0+

chromaSiting

TypeScript

get chromaSiting(): (vImageCVImageFormat_ChromaSiting) | null

Swift declaration

var chromaSiting: vImageCVImageFormat.ChromaSiting? { get set }

The chroma siting of a Core Video image format.

set · iOS 13.0+

chromaSiting

TypeScript

set chromaSiting(value: (vImageCVImageFormat_ChromaSiting) | null)

Swift declaration

var chromaSiting: vImageCVImageFormat.ChromaSiting? { get set }

The chroma siting of a Core Video image format.

get · iOS 13.0+

alphaIsOpaqueHint

TypeScript

get alphaIsOpaqueHint(): boolean

Swift declaration

var alphaIsOpaqueHint: Bool { get set }

The alpha hint of a Core Video image format.

set · iOS 13.0+

alphaIsOpaqueHint

TypeScript

set alphaIsOpaqueHint(value: boolean)

Swift declaration

var alphaIsOpaqueHint: Bool { get set }

The alpha hint of a Core Video image format.

method · iOS 13.0+

channelDescription

TypeScript

channelDescription(bufferType: vImage_BufferType): (vImageChannelDescription) | null

Swift declaration

func channelDescription(bufferType: vImage.BufferType) -> vImageChannelDescription?

Returns the channel description for a particular channel type.

static · iOS 13.0+

make

TypeScript

static makeBuffer(buffer: _CoreVideo_CVBuffer): (vImageCVImageFormat) | null

Swift declaration

static func make(buffer: CVPixelBuffer) -> vImageCVImageFormat?

Creates the description of how an image is encoded in an existing Core Video pixel buffer. - Parameter buffer: The CVPixelBufferRef on which to base the returned vImageCVImageFormatRef. - Returns: A `vImageCVImageFormatRef` instance encoded with the supplied pixel buffer's pixel format.

static · iOS 16.0+

make

TypeScript

static makeFormatColorSpaceAlphaIsOpaqueHint(format: vImageCVImageFormat_Format, colorSpace: _CoreGraphics_CGColorSpace, alphaIsOpaqueHint: boolean): (vImageCVImageFormat) | null

Swift declaration

static func make(format: vImageCVImageFormat.Format, colorSpace: CGColorSpace, alphaIsOpaqueHint: Bool) -> vImageCVImageFormat?

Creates the description of how an RGB image is encoded in a Core Video pixel buffer. - Parameter format: The format type of the image. - Parameter colorSpace: The color space of the RGB and monochrome images. - Parameter alphaIsOpaqueHint: A hint indicating that an image with an alpha channel should be treated as opaque. - Returns: A `vImageCVImageFormatRef` instance encoded with the function's parameters.

static · iOS 13.0+

make

TypeScript

static makeFormatMatrixChromaSitingColorSpaceAlphaIsOpaqueHint(format: vImageCVImageFormat_Format, matrix: vImage_ARGBToYpCbCrMatrix, chromaSiting: vImageCVImageFormat_ChromaSiting, colorSpace: _CoreGraphics_CGColorSpace, alphaIsOpaqueHint: boolean): (vImageCVImageFormat) | null

Swift declaration

static func make(format: vImageCVImageFormat.Format, matrix: vImage_ARGBToYpCbCrMatrix, chromaSiting: vImageCVImageFormat.ChromaSiting, colorSpace: CGColorSpace, alphaIsOpaqueHint: Bool) -> vImageCVImageFormat?

Creates the description of how an image is encoded in a Core Video pixel buffer. - Parameter format: The format type of the image. - Parameter matrix: A `vImage_ARGBToYpCbCrMatrix` that describes the conversion from RGB to the YpCbCr format. - Parameter chromaSiting: The chroma location. - Parameter colorSpace: The color space of the RGB and monochrome images. - Parameter alphaIsOpaqueHint: A hint indicating that an image with an alpha channel should be treated as opaque. - Returns: A `vImageCVImageFormatRef` instance encoded with the function's parameters.

get · iOS 13.0+

channels

TypeScript

get channels(): Array<vImage_BufferType>

Swift declaration

var channels: [vImage.BufferType] { get }

The names of the channels of a Core Video image format.

Skipped declarations

No declarations were skipped in this snapshot.

All Accelerate types →