Struct SaveScreenshot 

pub struct SaveScreenshot {
    pub world: WorldId,
    pub renderer: Option<u64>,
    pub target: Option<u64>,
    pub directory: String,
    pub file_name: Option<String>,
}

Available on crate feature mcp and non-WebAssembly only.

Arguments for saving a screenshot as an image.

Fields

world: WorldId

The world to drive: "Host" for the world the transport thread itself holds, or {"Handle": bits} for a world a host entity carries.

renderer: Option<u64>

The entity carrying the renderer, as its u64 bits. Omit for the world’s only one.

target: Option<u64>

The id of the texture to read, as list_resources reports it, or the id of any view of it. Omit for the world’s only readable texture.

directory: String

The directory to write the file into; created when it does not exist.

file_name: Option<String>

The file name to write; its extension picks the image format, and it is given a .webp one when it carries none.

Trait Implementations

impl Debug for SaveScreenshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SaveScreenshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SaveScreenshot

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.