Struct ResizeHint 

pub struct ResizeHint {
    pub can_resize: bool,
    pub can_resize_horizontally: bool,
    pub can_resize_vertically: bool,
    pub preserve_aspect_ratio: bool,
    pub aspect_ratio_width: u32,
    pub aspect_ratio_height: u32,
    pub size_constraints: SizeConstraints,
}

Describes whether and how a host may resize an Editor, returned from Editor::resize_hint().

The default is non-resizable (can_resize: false), matching the previous fixed-size behavior. To make an editor resizable, return a hint with can_resize: true; the per-axis flags and aspect-ratio fields refine how.

Fields

can_resize: bool

Whether the host may resize the editor at all. Drives CLAP’s gui.can_resize and VST3’s canResize. When false, the other fields are ignored.

can_resize_horizontally: bool

Whether the width may change. Only meaningful when can_resize is true.

can_resize_vertically: bool

Whether the height may change. Only meaningful when can_resize is true.

preserve_aspect_ratio: bool

If true, the host should keep the editor’s aspect ratio fixed at aspect_ratio_width : aspect_ratio_height while resizing.

aspect_ratio_width: u32

Aspect-ratio numerator (only used when preserve_aspect_ratio is true).

aspect_ratio_height: u32

Aspect-ratio denominator (only used when preserve_aspect_ratio is true).

size_constraints: SizeConstraints

Implementations

impl ResizeHint

pub const NON_RESIZABLE: Self

A non-resizable editor. This is the default value.

pub const RESIZABLE: Self

A freely resizable editor: both axes, no aspect-ratio lock. Convenience for the common case.

pub const fn non_resizable() -> Self

pub const fn resizable() -> Self

pub const fn with_min_logical_size(self, min_size: LogicalSize<f32>) -> Self

pub const fn with_min_max_logical_size( self, min_size: Option<LogicalSize<f32>>, max_size: Option<LogicalSize<f32>>, ) -> Self

pub const fn with_min_physical_size(self, min_size: PhysicalSize<u32>) -> Self

pub const fn with_min_max_physical_size( self, min_size: Option<PhysicalSize<u32>>, max_size: Option<PhysicalSize<u32>>, ) -> Self

pub const fn with_size_constraints( self, size_constraints: SizeConstraints, ) -> Self

pub const fn with_aspect_ratio( self, aspect_ratio_width: u32, aspect_ratio_height: u32, ) -> Self

• aspect_ratio_width: aspect-ratio numerator
• aspect_ratio_height: aspect-ratio denominator

pub fn is_size_valid( &self, new_size: PhysicalSize<u32>, current_size: PhysicalSize<u32>, scale_factor: f64, ) -> bool

Returns whether or not the given size in physical pixels is valid.

pub fn adjust_size( &self, new_size: PhysicalSize<u32>, current_size: PhysicalSize<u32>, scale_factor: f64, ) -> PhysicalSize<u32>

Adjust the new requested size to the closest size that is compatible with this plugin.

Trait Implementations

impl Clone for ResizeHint

fn clone(&self) -> ResizeHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ResizeHint

impl Debug for ResizeHint

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

Formats the value using the given formatter.

impl Default for ResizeHint

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ResizeHint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResizeHint