Skip to main content

ColorSpaceMenuParameters

Struct ColorSpaceMenuParameters 

Source
pub struct ColorSpaceMenuParameters { /* private fields */ }
Expand description

Mutable native options used to construct a color-space menu.

Implementations§

Source§

impl ColorSpaceMenuParameters

Source

pub fn serialize(&self) -> Result<String>

Serialize using OCIO’s diagnostic stream operator.

Source

pub fn create(config: &Config) -> Result<Self>

Create options for a configuration. The native parameters retain the config.

Source

pub fn create_from_const(config: &ConstConfig) -> Result<Self>

Create options retaining a read-only config without copying it.

Source

pub fn set_config(&mut self, config: &Config)

Replace the retained configuration.

Source

pub fn set_const_config(&mut self, config: &ConstConfig)

Replace the retained configuration with a read-only shared config.

Source

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

Return an editable copy of the retained native configuration. Native group-transform copies may retain children shared with the source.

Source

pub fn const_config(&self) -> Result<ConstConfig>

Retain the native configuration for read-only access without copying it.

Source

pub fn role(&self) -> &CStr

Return the native role setting.

Source

pub fn set_role(&mut self, value: &CStr)

Update the native role setting.

Source

pub fn include_color_spaces(&self) -> bool

Return the native include color spaces setting.

Source

pub fn set_include_color_spaces(&mut self, value: bool)

Update the native include color spaces setting.

Source

pub fn include_named_transforms(&self) -> bool

Return the native include named transforms setting.

Source

pub fn set_include_named_transforms(&mut self, value: bool)

Update the native include named transforms setting.

Source

pub fn treat_no_category_as_any(&self) -> bool

Available on crate feature v2_5 only.

Return the native treat no category as any setting.

Source

pub fn set_treat_no_category_as_any(&mut self, value: bool)

Available on crate feature v2_5 only.

Update the native treat no category as any setting.

Source

pub fn app_categories(&self) -> &CStr

Return the native app categories setting.

Source

pub fn set_app_categories(&mut self, value: &CStr)

Update the native app categories setting.

Source

pub fn encodings(&self) -> &CStr

Return the native encodings setting.

Source

pub fn set_encodings(&mut self, value: &CStr)

Update the native encodings setting.

Source

pub fn user_categories(&self) -> &CStr

Return the native user categories setting.

Source

pub fn set_user_categories(&mut self, value: &CStr)

Update the native user categories setting.

Source

pub fn include_roles(&self) -> bool

Return the native include roles setting.

Source

pub fn set_include_roles(&mut self, value: bool)

Update the native include roles setting.

Source

pub fn search_reference_space_type(&self) -> SearchReferenceSpaceType

Return the native search reference space type setting.

Source

pub fn set_search_reference_space_type( &mut self, value: SearchReferenceSpaceType, )

Update the native search reference space type setting.

Source

pub fn add_color_space(&mut self, name: &CStr)

Include an additional color space or named transform by name.

Source

pub fn num_added_color_spaces(&self) -> usize

Count explicitly added entries before native menu construction.

Source

pub fn added_color_space(&self, index: usize) -> &CStr

Return an explicitly added name, or an empty string for an invalid index.

Source

pub fn clear_added_color_spaces(&mut self)

Clear explicitly added entries.

Trait Implementations§

Source§

impl Drop for ColorSpaceMenuParameters

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.