Struct EngineParams

pub struct EngineParams {
    pub video_res_width: u32,
    pub video_res_height: u32,
    pub fps: u32,
    pub unlocked_framerate: bool,
    pub post_effect: Option<PostEffectType>,
    pub webrtc: bool,
    pub pool: Option<String>,
    pub show_grid: bool,
    pub replay: Option<String>,
    pub api_call_id: Option<String>,
}

Params for starting the engine.

Fields

video_res_width: u32

Width of the video feed. Must be a multiple of 4.

video_res_height: u32

Height of the video feed. Must be a multiple of 4.

fps: u32

Frames per second of the video feed.

unlocked_framerate: bool

If true, engine will render video frames as fast as it can.

post_effect: Option<PostEffectType>

Engine Post effects (such as SSAO)

webrtc: bool

If true, will start a webrtc connection.

pool: Option<String>

An optional identifier for a pool of engine instances. The ‘default’ pool is used when none is specified.

show_grid: bool

If true, will show the grid at the start of the session.

replay: Option<String>

If given, when the session ends, the modeling commands sent during the session will be written out to this filename. For debugging.

api_call_id: Option<String>

API Call ID for distributed tracing

Implementations

impl EngineParams

pub fn default_with_grid() -> Self

Returns a default EngineParams with the grid enabled. This is primarily useful for engine testing.

Trait Implementations

impl Debug for EngineParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EngineParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EngineParams

where EngineParams: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EngineParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for EngineParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.