Skip to main content

ConfigMergingParameters

Struct ConfigMergingParameters 

Source
pub struct ConfigMergingParameters { /* private fields */ }
Available on crate feature v2_5 only.
Expand description

Owned native configuration merge parameters.

Implementations§

Source§

impl ConfigMergingParameters

Source

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

Serialize using OCIO’s diagnostic stream operator.

Source

pub fn create() -> Result<Self>

Create via the native merge API.

Source

pub fn create_editable_copy(&self) -> Result<Self>

Create an editable copy via the native merge API.

OCIO copies the parameters but shares their internal override config; changes to search paths, environment, displays, and views are visible through both copies.

Source

pub fn base_config_name(&self) -> Result<&CStr>

Base config name via the native merge API.

Source

pub fn set_base_config_name(&mut self, value: &CStr) -> Result<()>

Set base config name via the native merge API.

Source

pub fn input_config_name(&self) -> Result<&CStr>

Input config name via the native merge API.

Source

pub fn set_input_config_name(&mut self, value: &CStr) -> Result<()>

Set input config name via the native merge API.

Source

pub fn output_name(&self) -> Result<&CStr>

Output name via the native merge API.

Source

pub fn set_output_name(&mut self, value: &CStr) -> Result<()>

Set output name via the native merge API.

Source

pub fn input_family_prefix(&self) -> Result<&CStr>

Input family prefix via the native merge API.

Source

pub fn set_input_family_prefix(&mut self, value: &CStr) -> Result<()>

Set input family prefix via the native merge API.

Source

pub fn base_family_prefix(&self) -> Result<&CStr>

Base family prefix via the native merge API.

Source

pub fn set_base_family_prefix(&mut self, value: &CStr) -> Result<()>

Set base family prefix via the native merge API.

Source

pub fn name(&self) -> Result<&CStr>

Name via the native merge API.

Source

pub fn set_name(&mut self, value: &CStr) -> Result<()>

Set name via the native merge API.

Source

pub fn description(&self) -> Result<&CStr>

Description via the native merge API.

Source

pub fn set_description(&mut self, value: &CStr) -> Result<()>

Set description via the native merge API.

Source

pub fn search_path(&self) -> Result<CString>

Search path as an owned snapshot of the shared native override config.

Source

pub fn set_search_path(&mut self, value: &CStr) -> Result<()>

Set search path via the native merge API.

Source

pub fn active_displays(&self) -> Result<CString>

Active displays as an owned snapshot of the shared native override config.

Source

pub fn set_active_displays(&mut self, value: &CStr) -> Result<()>

Set active displays via the native merge API.

Source

pub fn active_views(&self) -> Result<CString>

Active views as an owned snapshot of the shared native override config.

Source

pub fn set_active_views(&mut self, value: &CStr) -> Result<()>

Set active views via the native merge API.

Source

pub fn inactive_color_spaces(&self) -> Result<CString>

Inactive color spaces as an owned snapshot of the shared native override config.

Source

pub fn set_inactive_color_spaces(&mut self, value: &CStr) -> Result<()>

Set inactive color spaces via the native merge API.

Source

pub fn is_input_first(&self) -> Result<bool>

Is input first via the native merge API.

Source

pub fn set_input_first(&mut self, value: bool) -> Result<()>

Set input first via the native merge API.

Source

pub fn is_error_on_conflict(&self) -> Result<bool>

Is error on conflict via the native merge API.

Source

pub fn set_error_on_conflict(&mut self, value: bool) -> Result<()>

Set error on conflict via the native merge API.

Source

pub fn is_avoid_duplicates(&self) -> Result<bool>

Is avoid duplicates via the native merge API.

Source

pub fn set_avoid_duplicates(&mut self, value: bool) -> Result<()>

Set avoid duplicates via the native merge API.

Source

pub fn is_adjust_input_reference_space(&self) -> Result<bool>

Is adjust input reference space via the native merge API.

Source

pub fn set_adjust_input_reference_space(&mut self, value: bool) -> Result<()>

Set adjust input reference space via the native merge API.

Source

pub fn default_strategy(&self) -> Result<MergeStrategy>

Default strategy via the native merge API.

Source

pub fn set_default_strategy(&mut self, value: MergeStrategy) -> Result<()>

Set default strategy via the native merge API.

Source

pub fn roles(&self) -> Result<MergeStrategy>

Roles via the native merge API.

Source

pub fn set_roles(&mut self, value: MergeStrategy) -> Result<()>

Set roles via the native merge API.

Source

pub fn file_rules(&self) -> Result<MergeStrategy>

File rules via the native merge API.

Source

pub fn set_file_rules(&mut self, value: MergeStrategy) -> Result<()>

Set file rules via the native merge API.

Source

pub fn display_views(&self) -> Result<MergeStrategy>

Display views via the native merge API.

Source

pub fn set_display_views(&mut self, value: MergeStrategy) -> Result<()>

Set display views via the native merge API.

Source

pub fn view_transforms(&self) -> Result<MergeStrategy>

View transforms via the native merge API.

Source

pub fn set_view_transforms(&mut self, value: MergeStrategy) -> Result<()>

Set view transforms via the native merge API.

Source

pub fn looks(&self) -> Result<MergeStrategy>

Looks via the native merge API.

Source

pub fn set_looks(&mut self, value: MergeStrategy) -> Result<()>

Set looks via the native merge API.

Source

pub fn color_spaces(&self) -> Result<MergeStrategy>

Color spaces via the native merge API.

Source

pub fn set_color_spaces(&mut self, value: MergeStrategy) -> Result<()>

Set color spaces via the native merge API.

Source

pub fn named_transforms(&self) -> Result<MergeStrategy>

Named transforms via the native merge API.

Source

pub fn set_named_transforms(&mut self, value: MergeStrategy) -> Result<()>

Set named transforms via the native merge API.

Source

pub fn add_search_path(&mut self, value: &CStr) -> Result<()>

Add search path via the native merge API.

Source

pub fn add_environment_var(&mut self, name: &CStr, value: &CStr) -> Result<()>

Add environment var via the native merge API.

Source

pub fn num_environment_vars(&self) -> Result<i32>

Num environment vars via the native merge API.

Source

pub fn environment_var(&self, index: i32) -> Result<CString>

Environment variable name as an owned snapshot of the shared override config.

Source

pub fn environment_var_value(&self, index: i32) -> Result<CString>

Environment variable value as an owned snapshot of the shared override config.

Source

pub fn merge_configs(&self, base: &Config, input: &Config) -> Result<Config>

Merge configs via the native merge API.

Source

pub fn merge_configs_ref<'a, 'b>( &self, base: impl Into<ConfigRef<'a>>, input: impl Into<ConfigRef<'b>>, ) -> Result<Config>

Merge editable or retained read-only configs. Read-only configs are copied to isolate native cache-flag changes during merge heuristics.

Source

pub fn merge_color_space( &self, base: &Config, input: &ColorSpace, ) -> Result<Config>

Merge color space via the native merge API.

Source

pub fn merge_color_space_ref<'a, 'b>( &self, base: impl Into<ConfigRef<'a>>, input: impl Into<ColorSpaceRef<'b>>, ) -> Result<Config>

Merge an editable or retained read-only color space into an editable or retained read-only config. A read-only config is copied to isolate native cache-flag changes; the color-space handle is forwarded directly.

Trait Implementations§

Source§

impl Drop for ConfigMergingParameters

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.