Struct CommandBuilder 

pub struct CommandBuilder { /* private fields */ }

Builder for constructing graphics protocol commands

Implementations

impl CommandBuilder

pub fn new() -> Self

Create a new command builder

pub fn action(self, action: Action) -> Self

Set the action

pub fn format(self, format: ImageFormat) -> Self

Set the image format

pub fn medium(self, medium: TransmissionMedium) -> Self

Set the transmission medium

pub fn dimensions(self, width: u32, height: u32) -> Self

Set the image dimensions (width, height) in pixels

pub fn image_id(self, id: u32) -> Self

Set the image ID

pub fn image_number(self, number: u32) -> Self

Set the image number (alternative to image ID)

pub fn placement_id(self, id: u32) -> Self

Set the placement ID

pub fn more_data(self, more: bool) -> Self

Set the more data flag

pub fn compression(self, compression: Compression) -> Self

Set compression

pub fn quiet(self, mode: u8) -> Self

Set quiet mode (1 = suppress OK, 2 = suppress errors)

pub fn source_rect(self, x: u32, y: u32, width: u32, height: u32) -> Self

Set the source rectangle (x, y, width, height)

pub fn cell_offset(self, x: u32, y: u32) -> Self

Set cell offset (X, Y) within the current cell

pub fn display_area(self, columns: u32, rows: u32) -> Self

Set display area in columns and rows

pub fn z_index(self, z: i32) -> Self

Set z-index

pub fn cursor_policy(self, policy: CursorPolicy) -> Self

Set cursor policy

pub fn delete_target(self, target: DeleteTarget) -> Self

Set delete target

pub fn path(self, path: impl Into<String>) -> Self

Set file path or shared memory name

pub fn data_range(self, size: usize, offset: usize) -> Self

Set data size and offset for file/shared memory

pub fn unicode_placeholder(self, columns: u16, rows: u16) -> Self

Set unicode placeholder mode

pub fn parent(self, image_id: u32, placement_id: u32) -> Self

Set parent for relative placement

pub fn relative_offset(self, h: i32, v: i32) -> Self

Set relative offset for relative placement

pub fn animation_control(self, control: AnimationControl) -> Self

Set animation control

pub fn frame_number(self, frame: u32) -> Self

Set frame number

pub fn frame_gap(self, gap_ms: i32) -> Self

Set frame gap in milliseconds (negative = gapless frame)

pub fn loop_count(self, count: u32) -> Self

Set loop count (0 = ignored, 1 = infinite)

pub fn background_color(self, color: u32) -> Self

Set background color for frame (RGBA)

pub fn ref_frame(self, frame: u32) -> Self

Set reference frame for composition

pub fn composition(self, comp: FrameComposition) -> Self

Set frame composition parameters

pub fn build(self) -> Command

Build the command

Trait Implementations

impl Clone for CommandBuilder

fn clone(&self) -> CommandBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandBuilder

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

Formats the value using the given formatter.

impl Default for CommandBuilder

fn default() -> CommandBuilder

Returns the “default value” for a type.