MLGraphicsFrameParamsEx

Module: Graphics

The frame parameters requested for the next rendered frame. More...

#include <ml_graphics.h>

Public Attributes

Type	Name
uint32_t	version
float	near_clip
float	far_clip
float	focus_distance Distance, in meters, to defined focus point for the client content. The focus distance should be calculated as the positive distance to the client determined object of interest (relative to the forward vector of the Lightwear).
float	surface_scale The scale factor for the render surfaces, valid range is 0.0->1.0. The viewport returned from MLGraphicsBeginFrameEx will be adjusted to the closest width/height match to the request that can be supported by the graphics system.
bool	vignette
bool	protected_surface Content for this frame is protected and should not be recorded or captured outside the graphics system.
MLGraphicsProjectionType	projection_type
MLGraphicsEnvironmentBlendMode	blend_mode

Detailed Description

struct MLGraphicsFrameParamsEx;

The frame parameters requested for the next rendered frame.

The parameters defined by MLGraphicsFrameParamsEx are supplied to MLGraphicsBeginFrameEx from the client to define the requested characteristics of the next rendered frame.

This structure must be initialized by calling MLGraphicsFrameParamsExInit() before use.

Deprecated

Deprecated since 1.6.0. Scheduled for removal.

API Level:

• 21

---

Public Attributes Documentation

version

uint32_t version;

Struct API version.

---

near_clip

float near_clip;

Requested near clip plane distance in meters.

---

far_clip

float far_clip;

Far clipping plane distance in meters.

---

focus_distance

float focus_distance;

Distance, in meters, to defined focus point for the client content. The focus distance should be calculated as the positive distance to the client determined object of interest (relative to the forward vector of the Lightwear).

note

Note that 0.0 is an invalid value. The platform will attempt to provide default values but setting to 0.0 is strongly discouraged.

---

surface_scale

float surface_scale;

The scale factor for the render surfaces, valid range is 0.0->1.0. The viewport returned from MLGraphicsBeginFrameEx will be adjusted to the closest width/height match to the request that can be supported by the graphics system.

---

vignette

bool vignette;

Enable the platform level vignette for this frame.

---

protected_surface

bool protected_surface;

Content for this frame is protected and should not be recorded or captured outside the graphics system.

---

projection_type

MLGraphicsProjectionType projection_type;

Type	Description
MLGraphicsProjectionType	Defines the requested projection matrix model for rendering.

Requested projection model for rendering.

---

blend_mode

MLGraphicsEnvironmentBlendMode blend_mode;

Type	Description
MLGraphicsEnvironmentBlendMode	Defines how the final frame will be blended with environment.

Requested blend mode.

---