Skip to main content

ExposureContrastTransform

Struct ExposureContrastTransform 

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

Exposure/contrast/gamma style transform with optional dynamic controls.

The try_* queries preserve native errors. The infallible getters retain their compatibility fallback values if a native query fails.

Implementations§

Source§

impl ExposureContrastTransform

Source

pub fn try_exposure(&self) -> Result<f64>

Read exposure while preserving native errors.

Source

pub fn try_contrast(&self) -> Result<f64>

Read contrast while preserving native errors.

Source

pub fn try_gamma(&self) -> Result<f64>

Read gamma while preserving native errors.

Source

pub fn try_pivot(&self) -> Result<f64>

Read pivot while preserving native errors.

Source

pub fn try_log_exposure_step(&self) -> Result<f64>

Read log exposure step while preserving native errors.

Source

pub fn try_log_mid_gray(&self) -> Result<f64>

Read log mid-gray while preserving native errors.

Source

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

Read the dynamic exposure flag while preserving native errors.

Source

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

Read the dynamic contrast flag while preserving native errors.

Source

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

Read the dynamic gamma flag while preserving native errors.

Source

pub fn try_style(&self) -> Result<ExposureContrastStyle>

Read the native style, rejecting native errors and unknown values.

Source

pub fn create() -> Result<Self>

Create a new exposure-contrast transform.

Source

pub fn exposure(&self) -> f64

Return the current exposure value.

Source

pub fn set_exposure(&self, exposure: f64)

Set the exposure value.

Source

pub fn try_set_exposure(&self, exposure: f64) -> Result<()>

Set exposure and surface any OCIO validation error.

Source

pub fn contrast(&self) -> f64

Return the current contrast value.

Source

pub fn set_contrast(&self, contrast: f64)

Set the contrast value.

Source

pub fn try_set_contrast(&self, contrast: f64) -> Result<()>

Set contrast and surface any OCIO validation error.

Source

pub fn gamma(&self) -> f64

Return the current gamma value.

Source

pub fn set_gamma(&self, gamma: f64)

Set the gamma value.

Source

pub fn try_set_gamma(&self, gamma: f64) -> Result<()>

Set gamma and surface any OCIO validation error.

Source

pub fn pivot(&self) -> f64

Return the current pivot value.

Source

pub fn set_pivot(&self, pivot: f64)

Set the pivot value.

Source

pub fn try_set_pivot(&self, pivot: f64) -> Result<()>

Set pivot and surface any OCIO validation error.

Source

pub fn style(&self) -> ExposureContrastStyle

Return the current exposure-contrast style.

Source

pub fn set_style(&self, style: ExposureContrastStyle)

Set the exposure-contrast style.

Source

pub fn try_set_style(&self, style: ExposureContrastStyle) -> Result<()>

Set the exposure/contrast style and surface any OCIO validation error.

Source

pub fn is_exposure_dynamic(&self) -> bool

Return whether exposure is marked as dynamic.

Source

pub fn make_exposure_dynamic(&self)

Mark exposure as dynamic.

Source

pub fn try_make_exposure_dynamic(&self) -> Result<()>

Mark exposure as dynamic and surface any OCIO validation error.

Source

pub fn is_contrast_dynamic(&self) -> bool

Return whether contrast is marked as dynamic.

Source

pub fn make_contrast_dynamic(&self)

Mark contrast as dynamic.

Source

pub fn try_make_contrast_dynamic(&self) -> Result<()>

Mark contrast as dynamic and surface any OCIO validation error.

Source

pub fn make_exposure_non_dynamic(&self)

Mark exposure as non-dynamic.

Source

pub fn try_make_exposure_non_dynamic(&self) -> Result<()>

Mark exposure as non-dynamic and surface any OCIO validation error.

Source

pub fn make_contrast_non_dynamic(&self)

Mark contrast as non-dynamic.

Source

pub fn try_make_contrast_non_dynamic(&self) -> Result<()>

Mark contrast as non-dynamic and surface any OCIO validation error.

Source

pub fn is_gamma_dynamic(&self) -> bool

Return whether gamma is marked as dynamic.

Source

pub fn make_gamma_dynamic(&self)

Mark gamma as dynamic.

Source

pub fn try_make_gamma_dynamic(&self) -> Result<()>

Mark gamma as dynamic and surface any OCIO validation error.

Source

pub fn make_gamma_non_dynamic(&self)

Mark gamma as non-dynamic.

Source

pub fn try_make_gamma_non_dynamic(&self) -> Result<()>

Mark gamma as non-dynamic and surface any OCIO validation error.

Source

pub fn log_exposure_step(&self) -> f64

Return the log exposure step value.

Source

pub fn set_log_exposure_step(&self, step: f64)

Set the log exposure step value.

Source

pub fn try_set_log_exposure_step(&self, step: f64) -> Result<()>

Set the log exposure step and surface any OCIO validation error.

Source

pub fn log_mid_gray(&self) -> f64

Return the log mid-gray value.

Source

pub fn set_log_mid_gray(&self, mid_gray: f64)

Set the log mid-gray value.

Source

pub fn try_set_log_mid_gray(&self, mid_gray: f64) -> Result<()>

Set the log mid-gray value and surface any OCIO validation error.

Source

pub fn direction(&self) -> TransformDirection

Return the transform direction.

Source

pub fn set_direction(&self, direction: TransformDirection)

Set the transform direction.

Source

pub fn try_set_direction(&self, direction: TransformDirection) -> Result<()>

Set the transform direction and surface any OCIO validation error.

Source

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

Create an independent copy of this transform.

Source

pub fn format_metadata(&self) -> Option<FormatMetadata>

Return format metadata attached to the transform, when available.

Source

pub fn format_metadata_v1(&self) -> Option<FormatMetadata>

👎Deprecated since 0.2.0:

compat alias; prefer format_metadata()

Source

pub fn format_metadata_v2(&self) -> Option<FormatMetadata>

👎Deprecated since 0.2.0:

compat alias; prefer format_metadata()

Source

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

Return whether this transform is equivalent to other.

Trait Implementations§

Source§

impl Drop for ExposureContrastTransform

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
Source§

impl TransformHandle for ExposureContrastTransform

Source§

fn as_ptr(&self) -> *mut c_void

Source§

fn diagnostic_text(&self) -> Result<String>

Return OCIO’s diagnostic representation, which may include file paths. This text is not a stable interchange format.
Source§

fn try_type_tag(&self) -> Result<i32>

Return the version-independent tag corresponding to crate::TransformType.
Source§

fn try_set_direction(&mut self, direction: TransformDirection) -> Result<()>

Change the native evaluation direction without modifying the stored parameters.
Source§

fn try_validate(&self) -> Result<()>

Validate the native transform without copying it or building a processor.
Source§

fn try_create_editable_copy(&self) -> Result<Transform>

Create a native editable copy, preserving the concrete transform type. A copied group shares its children with the original. For an independent built-in group graph, use GroupTransform::create_deep_copy.
Source§

fn try_direction(&self) -> Result<TransformDirection>

Query the native direction with validation, for any supported transform.

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.