Struct SCNShadowMode

#[repr(transparent)]
pub struct SCNShadowMode(pub NSInteger);

Available on crate feature SCNLight only.

The different modes available to compute shadows.

When the shadow mode is set to SCNShadowModeForward, shadows are computed while computing the lighting. In this mode only the alpha component of the shadow color is used to alter the lighting contribution. When the shadow mode is set to SCNShadowModeDeferred shadows are applied as a post process. Shadows are blend over the final image and can therefor be of any arbitrary color. However it is most of the time less efficient than SCNShadowModeForward, except when a scene has a lot of overdraw. When the shadow mode is set to SCNShadowModeModulated the light doesn’t illuminate the scene anymore, it only casts shadows. Therefore setting the light color has no effect. In this mode gobos act as a shadow projector: the gobo image is modulated with the shadow receiver’s fragments. The typical usage is to use an image of a radial gradient (black to white) that is projected under a character (and use the categoryBitMask of the light and nodes to exclude the character from the shadow receiver).

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl SCNShadowMode

pub const Forward: Self

pub const Deferred: Self

pub const Modulated: Self

Trait Implementations

impl Clone for SCNShadowMode

fn clone(&self) -> SCNShadowMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SCNShadowMode

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

Formats the value using the given formatter.

impl Encode for SCNShadowMode

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for SCNShadowMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SCNShadowMode

fn cmp(&self, other: &SCNShadowMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SCNShadowMode

fn eq(&self, other: &SCNShadowMode) -> 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 PartialOrd for SCNShadowMode

fn partial_cmp(&self, other: &SCNShadowMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for SCNShadowMode

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for SCNShadowMode

impl Eq for SCNShadowMode

impl StructuralPartialEq for SCNShadowMode