Type Alias Restv1BetaRenderSceneRequestWritable

type Restv1BetaRenderSceneRequestWritable = {
    autoFraming?: TypesAutoFramingOptions;
    background?: TypesBackgroundOptions;
    cameraName?: string;
    extraOutputs?: TypesRenderExtraOutputs;
    groundPlane?: TypesGroundPlaneOptions;
    scene: TypesSceneDescription;
    size?: TypesSizeOptions;
    sources: RestBaseMountedSource[] | null;
}

Index

Properties

autoFraming? background? cameraName? extraOutputs? groundPlane? scene size? sources

Properties

`Optional`autoFraming

autoFraming?: TypesAutoFramingOptions

Auto-framing related options.

`Optional`background

background?: TypesBackgroundOptions

Background related options.

`Optional`cameraName

cameraName?: string

If set, this camera is used to perform the render. The camera has to be defined in the scene.

`Optional`extraOutputs

extraOutputs?: TypesRenderExtraOutputs

Request additional outputs from the renderer.

`Optional`groundPlane

groundPlane?: TypesGroundPlaneOptions

Options related to the ground plane.

scene

scene: TypesSceneDescription

Define rendering scene primitives.

`Optional`size

size?: TypesSizeOptions

Render size related options.

sources

sources: RestBaseMountedSource[] | null

List of sources to aggregate and run the job against.