pub struct FileTransform { /* private fields */ }Expand description
A transform backed by an external LUT or color-correction file.
The source path is resolved by OCIO using the active config/context.
Implementations§
Source§impl FileTransform
impl FileTransform
Sourcepub fn set_src(&self, src: impl AsRef<str>) -> Result<()>
pub fn set_src(&self, src: impl AsRef<str>) -> Result<()>
Set the source path or URI used to load the external transform data.
Sourcepub fn ccc_id(&self) -> Option<String>
pub fn ccc_id(&self) -> Option<String>
Return the optional CCC identifier used with multi-grade CDL files.
Sourcepub fn set_ccc_id(&self, id: impl AsRef<str>) -> Result<()>
pub fn set_ccc_id(&self, id: impl AsRef<str>) -> Result<()>
Set the optional CCC identifier used with multi-grade CDL files.
Sourcepub fn interpolation(&self) -> Interpolation
pub fn interpolation(&self) -> Interpolation
Return the interpolation mode requested for LUT sampling.
Sourcepub fn set_interpolation(&self, interp: Interpolation)
pub fn set_interpolation(&self, interp: Interpolation)
Set the interpolation mode requested for LUT sampling.
Sourcepub fn try_set_interpolation(&self, interp: Interpolation) -> Result<()>
pub fn try_set_interpolation(&self, interp: Interpolation) -> Result<()>
Set interpolation and surface any OCIO validation error.
Sourcepub fn cdl_style(&self) -> CDLStyle
pub fn cdl_style(&self) -> CDLStyle
Return the CDL style used when the file source is CDL-based.
Sourcepub fn set_cdl_style(&self, style: CDLStyle)
pub fn set_cdl_style(&self, style: CDLStyle)
Set the CDL style used when the file source is CDL-based.
Sourcepub fn try_set_cdl_style(&self, style: CDLStyle) -> Result<()>
pub fn try_set_cdl_style(&self, style: CDLStyle) -> Result<()>
Set the CDL style and surface any OCIO validation error.
Sourcepub fn direction(&self) -> TransformDirection
pub fn direction(&self) -> TransformDirection
Return the transform direction used when this op is evaluated.
Sourcepub fn set_direction(&self, direction: TransformDirection)
pub fn set_direction(&self, direction: TransformDirection)
Set the transform direction used when this op is evaluated.
Sourcepub fn try_set_direction(&self, direction: TransformDirection) -> Result<()>
pub fn try_set_direction(&self, direction: TransformDirection) -> Result<()>
Set the transform direction and surface any OCIO validation error.
Sourcepub fn create_editable_copy(&self) -> Result<Self>
pub fn create_editable_copy(&self) -> Result<Self>
Create an editable copy that is independent from the original transform.
Sourcepub fn format_metadata(&self) -> Option<FormatMetadata>
pub fn format_metadata(&self) -> Option<FormatMetadata>
Return format metadata attached to the transform, when available.
Sourcepub fn num_formats() -> i32
pub fn num_formats() -> i32
Return the number of reader formats supported by FileTransform.
Sourcepub fn format_name_by_index(index: i32) -> Option<String>
pub fn format_name_by_index(index: i32) -> Option<String>
Return the reader format name at index, or None for an invalid index.
Sourcepub fn format_extension_by_index(index: i32) -> Option<String>
pub fn format_extension_by_index(index: i32) -> Option<String>
Return the reader format extension at index, without a leading dot.
Returns None for an invalid index.
Sourcepub fn is_format_extension_supported(extension: impl AsRef<str>) -> bool
pub fn is_format_extension_supported(extension: impl AsRef<str>) -> bool
Return whether extension is recognized by the upstream file readers.
Trait Implementations§
Source§impl Drop for FileTransform
impl Drop for FileTransform
Source§impl TransformHandle for FileTransform
impl TransformHandle for FileTransform
fn as_ptr(&self) -> *mut c_void
Source§fn diagnostic_text(&self) -> Result<String>
fn diagnostic_text(&self) -> Result<String>
Source§fn try_type_tag(&self) -> Result<i32>
fn try_type_tag(&self) -> Result<i32>
crate::TransformType.Source§fn try_set_direction(&mut self, direction: TransformDirection) -> Result<()>
fn try_set_direction(&mut self, direction: TransformDirection) -> Result<()>
Source§fn try_validate(&self) -> Result<()>
fn try_validate(&self) -> Result<()>
Source§fn try_create_editable_copy(&self) -> Result<Transform>
fn try_create_editable_copy(&self) -> Result<Transform>
GroupTransform::create_deep_copy.