Enum exr::block::samples::Sample

pub enum Sample {
    F16(f16),
    F32(f32),
    U32(u32),
}

A single red, green, blue, or alpha value.

Variants

F16(f16)

A 16-bit float sample.

F32(f32)

A 32-bit float sample.

U32(u32)

An unsigned integer sample.

Implementations

impl Sample

pub fn f32(f32: f32) -> Self

Create a sample containing a 32-bit float.

pub fn f16(f16: f16) -> Self

Create a sample containing a 16-bit float.

pub fn u32(u32: u32) -> Self

Create a sample containing a 32-bit integer.

pub fn to_f16(self) -> f16

Convert the sample to an f16 value. This has lower precision than f32. Note: An f32 can only represent integers up to 1024 as precise as a u32 could.

pub fn to_f32(self) -> f32

Convert the sample to an f32 value. Note: An f32 can only represent integers up to 8388608 as precise as a u32 could.

pub fn to_u32(self) -> u32

Convert the sample to a u32. Rounds floats to integers the same way that 3.1 as u32 does.

pub fn is_nan(self) -> bool

Is this value not a number?

pub fn is_zero(&self) -> bool

Is this value zero or negative zero?

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Default for Sample

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<Option<T>> for Sample

where T: Into<Sample> + Default,

fn from(num: Option<T>) -> Self

Converts to this type from the input type.

impl From<Sample> for f16

fn from(s: Sample) -> Self

Converts to this type from the input type.

impl From<Sample> for f32

fn from(s: Sample) -> Self

Converts to this type from the input type.

impl From<Sample> for u32

fn from(s: Sample) -> Self

Converts to this type from the input type.

impl From<f16> for Sample

fn from(f: f16) -> Self

Converts to this type from the input type.

impl From<f32> for Sample

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<u32> for Sample

fn from(f: u32) -> Self

Converts to this type from the input type.

impl FromNativeSample for Sample

fn from_f16(value: f16) -> Self

Create this sample from a f16, trying to represent the same numerical value

fn from_f32(value: f32) -> Self

Create this sample from a f32, trying to represent the same numerical value

fn from_u32(value: u32) -> Self

Create this sample from a u32, trying to represent the same numerical value

fn from_f16s(from: &[f16], to: &mut [Self])

Convert all values from the slice into this type. This function exists to allow the compiler to perform a vectorization optimization. Note that this default implementation will not be vectorized by the compiler automatically. For maximum performance you will need to override this function and implement it via an explicit batched conversion such as convert_to_f32_slice

fn from_f32s(from: &[f32], to: &mut [Self])

Convert all values from the slice into this type. This function exists to allow the compiler to perform a vectorization optimization. Note that this default implementation will be vectorized by the compiler automatically.

fn from_u32s(from: &[u32], to: &mut [Self])

Convert all values from the slice into this type. This function exists to allow the compiler to perform a vectorization optimization. Note that this default implementation will be vectorized by the compiler automatically, provided that the CPU supports the necessary conversion instructions. For example, x86_64 lacks the instructions to convert u32 to floats, so this will inevitably be slow on x86_64.

impl IntoNativeSample for Sample

fn to_f16(&self) -> f16

Convert this sample to an f16, trying to represent the same numerical value.

fn to_f32(&self) -> f32

Convert this sample to an f32, trying to represent the same numerical value.

fn to_u32(&self) -> u32

Convert this sample to an u16, trying to represent the same numerical value.

impl PartialEq for Sample

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValidateResult for Sample

fn validate_result( &self, other: &Self, options: ValidationOptions, location: impl Fn() -> String, ) -> ValidationResult

Compare self with the other. Exceptional behaviour:

fn assert_equals_result(&self, result: &Self)

Compare self with the other. Panics if not equal.

impl Copy for Sample