Skip to main content
Version: 20 Mar 2024

MLGraphicsVirtualCameraInfo

Module: Graphics

The per virtual camera information as defined in #MLGraphicsVirtualCameraInfoArray. More...

#include <ml_graphics.h>

Public Attributes

TypeName
floatleft_half_angle
floatright_half_angle
floattop_half_angle
floatbottom_half_angle
MLHandlesync_object
The handle of the sync object to signal after submitting all GPU work for the virtual camera.
MLMat4fprojection
MLTransformtransform
The local space (relative to world) camera transform needed to render content, inverse is view matrix.
MLGraphicsVirtualCameraNamevirtual_camera_name

Detailed Description

struct MLGraphicsVirtualCameraInfo;

The per virtual camera information as defined in #MLGraphicsVirtualCameraInfoArray.

For each virtual camera the client is provided the exact definition of the camera properties along with the matrices needed to construct the full transform chain. In general the transform chain for each virtual camera is defined as MATprojection * inv(MATtransform) for RHS multiplication.

Note: The projection model is asymmetric and clients should not assume any of the symmetric properties of projection. Additionally both the transform and projection will change per frame and cannot be assumed to be static.

Deprecated

Deprecated since 1.6.0. Scheduled for removal.


Public Attributes Documentation

left_half_angle

float left_half_angle;

The FOV left half angle, in radians.


right_half_angle

float right_half_angle;

The FOV right half angle, in radians.


top_half_angle

float top_half_angle;

The FOV top half angle, in radians.


bottom_half_angle

float bottom_half_angle;

The FOV bottom half angle, in radians.


sync_object

MLHandle sync_object;

The handle of the sync object to signal after submitting all GPU work for the virtual camera.

TypeDescription
MLHandleInteger handle type used to reference many things returned by the API, instead of returning pointers directly. Use MLHandleIsValid() to check if a handle is valid or not.

projection

MLMat4f projection;

The projection matrix for the virtual camera.


transform

MLTransform transform;

The local space (relative to world) camera transform needed to render content, inverse is view matrix.


virtual_camera_name

MLGraphicsVirtualCameraName virtual_camera_name;
TypeDescription
MLGraphicsVirtualCameraNameThe metadata name associated with each virtual camera.

The name of the virtual camera.