Struct Args 

pub struct Args {

    pub config: Option<PathBuf>,
    pub mcp: bool,
    pub output: Option<PathBuf>,
    pub output_size: Option<(u32, u32)>,
    pub render_size: Option<(u32, u32)>,
    pub scale: Option<(f32, f32)>,
    pub samples: Option<u32>,
    pub no_depth: bool,
    pub clear: Option<[f64; 4]>,
    pub eye: Option<[f32; 3]>,
    pub target: Option<[f32; 3]>,
    pub up: Option<[f32; 3]>,
    pub fov_y: Option<f32>,
    pub z_near: Option<f32>,
    pub camera_view_matrix: Option<[f32; 16]>,
    pub camera_projection_matrix: Option<[f32; 16]>,
    pub document: Vec<PathBuf>,
    pub animation: Option<String>,
    pub time: Option<f32>,
}

The command-line arguments.

Every option overrides the same-named field of the JSON configuration.

Fields

config: Option<PathBuf>

a JSON configuration file. Command-line options override its fields.

mcp: bool

serve the Model Context Protocol over stdio instead of rendering once. The host starts from an empty offscreen world and the tool calls build the scene; every other option is ignored.

output: Option<PathBuf>

the output image path; its extension chooses the format (png, webp or jpeg). Required unless –mcp is given.

output_size: Option<(u32, u32)>

the output image size, as WxH.

render_size: Option<(u32, u32)>

the render size the camera and viewport are based on, as WxH.

scale: Option<(f32, f32)>

the factors scaling the render size inside the output size, as S or SX,SY.

samples: Option<u32>

the multisample count: 1, 2, 4 or 8.

no_depth: bool

render without a depth buffer.

clear: Option<[f64; 4]>

the clear colour, as R,G,B or R,G,B,A, each in 0..=1.

eye: Option<[f32; 3]>

the camera eye position, as X,Y,Z.

target: Option<[f32; 3]>

the camera target position, as X,Y,Z.

up: Option<[f32; 3]>

the camera up vector, as X,Y,Z.

fov_y: Option<f32>

the vertical field of view in degrees.

z_near: Option<f32>

the near plane distance.

camera_view_matrix: Option<[f32; 16]>

a view (world-to-view) matrix, column-major, as 16 comma-separated numbers; give it together with –camera-projection-matrix.

camera_projection_matrix: Option<[f32; 16]>

a projection (view-to-clip) matrix, column-major, as 16 comma-separated numbers; give it together with –camera-view-matrix.

document: Vec<PathBuf>

a glTF document to render; repeatable. Replaces the configuration list.

animation: Option<String>

the animation to play, by name or index; applies to every document.

time: Option<f32>

the animation time in seconds.

Implementations

impl Args

pub fn config(&self) -> Result<Config, String>

Read the configuration file, if any, and apply the overrides.

Errors

Fails when the configuration file cannot be read or parsed.

fn apply(&self, config: &mut Config)

Apply every command-line override to config.

Trait Implementations

impl Clone for Args

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgs for Args

fn from_args(__cmd_name: &[&str], __args: &[&str]) -> Result<Self, EarlyExit>

Construct the type from an input set of arguments.

fn redact_arg_values( __cmd_name: &[&str], __args: &[&str], ) -> Result<Vec<String>, EarlyExit>

Get a String with just the argument names, e.g., options, flags, subcommands, etc, but without the values of the options and arguments. This can be useful as a means to capture anonymous usage statistics without revealing the content entered by the end user.

impl PartialEq for Args

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Args

impl TopLevelCommand for Args