Class ImageFormat

Index

Constructors

Properties

faceOrientation fov height orientation requireMirroring width

Methods

Constructors

constructor

new ImageFormat(): ImageFormat
Construct a new ImageFormat object with default values.

Returns ImageFormat
new ImageFormat(
    width: number,
    height: number,
    orientation: CameraOrientation,
    requireMirroring: boolean,
    faceOrientation: number,
    fov?: number,
): ImageFormat
Construct a new ImageFormat object with user's params.
Parameters
- width: number
  width of the image in pixels.
- height: number
  height of the image in pixels.
- orientation: CameraOrientation
  the image camera orientation in degrees as enum value.
- requireMirroring: boolean
  specifies should the image be mirrored during rendering or not.
- faceOrientation: number
  face orientation in degrees.
- Optionalfov: number
  field of view in degrees.
Returns ImageFormat

Properties

`Readonly`faceOrientation

faceOrientation: number

face orientation in degrees.

`Readonly`fov

fov: number

field of view in degrees.

`Readonly`height

height: number

height of the image in pixels.

`Readonly`orientation

orientation: CameraOrientation

camera orientation in degrees as enum value.

`Readonly`requireMirroring

requireMirroring: boolean

specifies should the image be mirrored during rendering or not.

`Readonly`width

width: number

width of the image in pixels.

Methods

size

size(): number
Returns number
the image size in pixels, i.e. width * height.