CoreVideo · IOS API REFERENCE

CVImageDisplayMaskRectangle

struct · iOS 27.0+ · SDK 27.1

struct CVImageDisplayMaskRectangle

Specifies the rectangular display area within the image. The mask is specified relative to a reference raster width and height that should be scaled to the image buffer dimensions. The origin (0, 0) is at the top-left.

Members (15)

get · iOS 27.0+

referenceRasterWidth

TypeScript

get referenceRasterWidth(): number

Swift declaration

var referenceRasterWidth: UInt16

The width in pixels of the 2D coordinate system to define the rectangle. Usually matches the width of the video or the output device.

set · iOS 27.0+

referenceRasterWidth

TypeScript

set referenceRasterWidth(value: number)

Swift declaration

var referenceRasterWidth: UInt16

The width in pixels of the 2D coordinate system to define the rectangle. Usually matches the width of the video or the output device.

get · iOS 27.0+

referenceRasterHeight

TypeScript

get referenceRasterHeight(): number

Swift declaration

var referenceRasterHeight: UInt16

Specifies the height in pixels of the 2D coordinate system to define the rectangle. Usually matches the height of the video or the output device.

set · iOS 27.0+

referenceRasterHeight

TypeScript

set referenceRasterHeight(value: number)

Swift declaration

var referenceRasterHeight: UInt16

Specifies the height in pixels of the 2D coordinate system to define the rectangle. Usually matches the height of the video or the output device.

static · iOS 27.0+

makeFromRawAttachmentValue

TypeScript

static makeFromRawAttachmentValue(repr: CVAttachmentRawValue): (CVImageDisplayMaskRectangle) | null

Swift declaration

static func makeFromRawAttachmentValue(_ repr: CVAttachmentRawValue) -> CVImageDisplayMaskRectangle?

get · iOS 27.0+

rawAttachmentValueRepresentation

TypeScript

get rawAttachmentValueRepresentation(): CVAttachmentRawValue

Swift declaration

var rawAttachmentValueRepresentation: CVAttachmentRawValue { get }

get · iOS 27.0+

top

TypeScript

get top(): number

Swift declaration

var top: UInt16

The vertical pixel offset of the rectangle from the top of the bounding raster. This value is always less than ``referenceRasterHeight``.

set · iOS 27.0+

top

TypeScript

set top(value: number)

Swift declaration

var top: UInt16

The vertical pixel offset of the rectangle from the top of the bounding raster. This value is always less than ``referenceRasterHeight``.

init · iOS 27.0+

init

TypeScript

static init(left: number, top: number, width: number, height: number, referenceRasterWidth: number, referenceRasterHeight: number): CVImageDisplayMaskRectangle

Swift declaration

init(left: UInt16, top: UInt16, width: UInt16, height: UInt16, referenceRasterWidth: UInt16, referenceRasterHeight: UInt16)

get · iOS 27.0+

left

TypeScript

get left(): number

Swift declaration

var left: UInt16

The horizontal pixel offset of the rectangle from the left of the bounding raster. This value is always less than ``referenceRasterWidth``.

set · iOS 27.0+

left

TypeScript

set left(value: number)

Swift declaration

var left: UInt16

The horizontal pixel offset of the rectangle from the left of the bounding raster. This value is always less than ``referenceRasterWidth``.

get · iOS 27.0+

width

TypeScript

get width(): number

Swift declaration

var width: UInt16

The width of the rectangle starting at rectangle's left offset toward the rectangle's right edge. This value is always less than ``referenceRasterWidth``.

set · iOS 27.0+

width

TypeScript

set width(value: number)

Swift declaration

var width: UInt16

The width of the rectangle starting at rectangle's left offset toward the rectangle's right edge. This value is always less than ``referenceRasterWidth``.

get · iOS 27.0+

height

TypeScript

get height(): number

Swift declaration

var height: UInt16

The height of the rectangle starting at rectangle's top offset toward the rectangle's bottom edge. This value is always less than ``referenceRasterHeight``.

set · iOS 27.0+

height

TypeScript

set height(value: number)

Swift declaration

var height: UInt16

The height of the rectangle starting at rectangle's top offset toward the rectangle's bottom edge. This value is always less than ``referenceRasterHeight``.

Skipped declarations

No declarations were skipped in this snapshot.

All CoreVideo types →