Struct RawDistancePixel 

pub struct RawDistancePixel(/* private fields */);

A raw pixel in a 2D image

This is either a single distance value or a description of a fill; both cases are packed into an f32 (using NaN-boxing in the latter case).

The NaN-boxing is transparent to the user; for the curious, it is implemented by splitting the mantissa into three components:

• Bit 0 indicates the sign of the fill (1 for inside, 0 for outside)
• Bits 1-9 indicate the depth at which evaluation terminated, which is useful for certain debug visualizations
• Bits 10-17 are a fixed bit pattern, which both ensures that the value is treated as NaN in the [empty, depth 0] case (rather than infinity) and distinguishes from NaN values generated during normal evaluation

Implementations

impl RawDistancePixel

pub fn inside(self) -> bool

Checks whether the pixel is inside or outside the model

Distances of exactly 0.0 and non-boxed NaN values are treated as outside (i.e. returning false).

pub fn is_distance(self) -> bool

Checks whether this is a distance point sample

pub fn unpack(self) -> DistancePixel

Unpacks into a DistancePixel

pub fn distance(self) -> Option<f32>

Returns the distance value if this is a DistancePixel::Value

Trait Implementations

impl Clone for RawDistancePixel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RawDistancePixel

impl Debug for RawDistancePixel

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

Formats the value using the given formatter.

impl Default for RawDistancePixel

fn default() -> Self

Returns the “default value” for a type.

impl From<DistancePixel> for RawDistancePixel

fn from(p: DistancePixel) -> Self

Converts to this type from the input type.

impl From<f32> for RawDistancePixel

fn from(p: f32) -> Self

Converts to this type from the input type.

impl FromBytes for RawDistancePixel

where f32: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for RawDistancePixel

where f32: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Immutable for RawDistancePixel

where f32: Immutable,

impl IntoBytes for RawDistancePixel

where f32: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl TryFromBytes for RawDistancePixel

where f32: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.