CameraParameters

Description

sealed class Tinman.Engine.Rendering.Effects.Shared.CameraParameters

Derived from

RenderEffectParameters abstract

Shared render effect parameters for the scene camera.

The following low-level render effect parameter slots are always defined:

The following low-level render effect parameter slots are omitted if FlagNoCamera is present:

The following low-level render effect parameter slots are omitted if FlagNoFar is present:

Public / Constants

Changed​Direction

public constant ChangedDirection → (1:int32)

Changed flag for Direction.

Changed​Direction​Locked

public constant ChangedDirectionLocked → (1 << 2:int32)

Changed flag for DirectionLocked.

Changed​Position

public constant ChangedPosition → (1 << 3:int32)

Changed flag for Position.

Changed​Position​Locked

public constant ChangedPositionLocked → (1 << 4:int32)

Changed flag for PositionLocked.

Changed​View​Projection​Far

public constant ChangedViewProjectionFar → (1 << 5:int32)

Changed flag for ViewProjectionFar.

Changed​View​Projection​Matrix

public constant ChangedViewProjectionMatrix → (1 << 6:int32)

Changed flag for ViewProjectionMatrix.

Changed​View​Projection​Matrix​Inverse

public constant ChangedViewProjectionMatrixInverse → (1 << 7:int32)

Changed flag for ViewProjectionMatrixInverse.

Flag​No​Camera

public constant FlagNoCamera → (1:int32)

When present, low-level render effect parameter slots that are related to camera properties will be omitted.

See also

RenderEffectParameters.Declare

Flag​No​Far

public constant FlagNoFar → (2:int32)

When present, low-level render effect parameter slots that are related to the far plane of the projection will be omitted.

See also

RenderEffectParameters.Declare

Public / Constructors

Camera​Parameters

public constructor CameraParameters → ()

Creates a new instance of CameraParameters.

Public / Methods

Set

4 overloads

public method Set1 → (2)

shadowMapping in : ShadowMapping

[not-null]
The ShadowMapping object to read state values from.

cascade in : int32

[0..shadowMapping.CascadeCount-1]
The shadow cascade that is being rendered.

Sets the camera state, using the values of the given ShadowMapping object.

The following parameters are updated by this method:

public method Set2 → (2)

viewport in : CameraViewport

[not-null]
The CameraViewport object to read state values from.

local opt : bool = true

Use local view matrix (true) or regular one (false)?

Sets the camera state, using the values of the given CameraViewport object.

The following parameters are updated by this method:

See also

CameraViewport.MatrixView
CameraViewport.MatrixViewLocal

public method Set3 → (2)

camera in : Camera

[not-null]
The Camera object to read state values from.

isLocked opt : bool = false

Retain locked camera state (true) or also update locked camera state (false)?

Sets the camera state, using the values of the given Camera object.

The following parameters are updated by this method:

These parameters are updated if isLocked opt is false:

See also

CameraViewport.MatrixView
CameraViewport.MatrixViewLocal

public method Set4 → (2)

cameraInfo in : CameraInfo

[not-null]
The CameraInfo object to read state values from.

isLocked opt : bool = false

Retain locked camera state (true) or also update locked camera state (false)?

Sets the camera state, using the values of the given CameraInfo object.

The following parameters are updated by this method:

These parameters are updated if isLocked opt is false:

See also

CameraViewport.MatrixView
CameraViewport.MatrixViewLocal

Public / Attributes

Direction

public attribute Direction → (get,set)

value : Vec3F

The direction vector.

Direction vector of camera, in world-space.

Defaults to Vec3F.Zero.

See also

CameraParameters.ChangedDirection

Direction​Locked

public attribute DirectionLocked → (get,set)

value : Vec3F

The direction vector.

The camera direction, when the view is locked.

Defaults to Vec3F.Zero.

See also

CameraParameters.ChangedDirectionLocked

Position

public attribute Position → (get,set)

value : Vec3D

The position vector.

Camera position, in world-space.

Defaults to Vec3D.Zero.

See also

CameraParameters.ChangedPosition

Position​Locked

public attribute PositionLocked → (get,set)

value : Vec3D

The position vector.

The camera position, when the view is locked.

Defaults to Vec3D.Zero.

See also

CameraParameters.ChangedPositionLocked

View​Projection​Far

public attribute ViewProjectionFar → (get,set)

value : float32

The Z-coordinate value.

Z-coordinate of far clipping plane.

Defaults to 0.

See also

CameraParameters.ChangedViewProjectionFar

View​Projection​Matrix

public attribute ViewProjectionMatrix → (get,set)

value : Mat4F

The matrix.

View-projection matrix, centered at camera.

Defaults to Mat4F.Zero.

See also

CameraParameters.ChangedViewProjectionMatrix

View​Projection​Matrix​Inverse

public attribute ViewProjectionMatrixInverse → (get,set)

value : Mat4F

The matrix.

Inverse view-projection matrix, centered at camera.

Defaults to Mat4F.Zero.

See also

CameraParameters.ChangedViewProjectionMatrixInverse