Skip to main content

SampleMode

Enum SampleMode 

Source
pub enum SampleMode {
    Sample,
    Level(NodeRef),
    Bias(NodeRef),
    Grad(NodeRef, NodeRef),
    Gather {
        component: NodeRef,
        offset: Option<NodeRef>,
    },
    GatherCompare {
        compare: NodeRef,
        offset: Option<NodeRef>,
    },
    Load,
    LoadLayer(NodeRef),
    SampleLayer(NodeRef),
    Compare(NodeRef),
    LoadTexel,
    StorageLoad,
}
Expand description

How a TextureNode reads its texture — WGSLNodeBuilder.generateTexture*.

Variants§

§

Sample

textureSample( t, t_sampler, uv ).

§

Level(NodeRef)

textureSampleLevel( t, t_sampler, uv, level ).

§

Bias(NodeRef)

textureSampleBias( t, t_sampler, uv, bias ) — textureNode.bias( value ). FXAANode samples its input at a bias of -100, pinning every tap to the top mip.

§

Grad(NodeRef, NodeRef)

textureSampleGrad( t, t_sampler, uv, gradX, gradY ) — textureNode.grad( gradX, gradY ) (generateTextureGrad()), each gradient built as a vec2.

§

Gather

textureGather( component, t, t_sampler, uv[, offset] ) — textureNode.gather( component ), optionally .offset( ivec2 ) (WGSLNodeBuilder.generateTextureGather()): one channel of the four texels a bilinear tap would read, from mip level 0.

Fields

§component: NodeRef

Which channel to gather (0–3).

§offset: Option<NodeRef>

An optional texel offset — .offset( ivec2 ).

§

GatherCompare

textureGatherCompare( t, t_sampler, uv, depth[, offset] ) — depthNode.gather().compare( depth ) on a depth texture with a comparison sampler (generateTextureGatherCompare()): the four texels’ comparison results.

Fields

§compare: NodeRef

The depth value each of the four texels is compared against.

§offset: Option<NodeRef>

An optional texel offset — .offset( ivec2 ).

§

Load

The non-filterable path: textureLoad against textureDimensions, with no sampler binding at all. What Three emits for a depth texture.

§

LoadLayer(NodeRef)

textureLoad( t, coord, layer, u32( 0u ) ) on a 2-D-array texture — textureLoad( … ).depth( layer ), with no clamping and no sampler.

§

SampleLayer(NodeRef)

textureSample( t, t_sampler, uv, i32( layer ) ) on a 2-D-array texture — texture( map, uv ).depth( layer ). Three builds the depth node as 'int', so a float layer arrives truncated by i32().

§

Compare(NodeRef)

textureSampleCompare( t, t_sampler, uv, depth ) — the depth-compare read ShadowFilterNode’s depthCompare lowers to.

§

LoadTexel

textureLoad( t, coord, u32( 0u ) ) — an unclamped texel fetch at an integer coordinate, what Batch.js reads its data textures with. When the node’s type is a scalar the snippet is swizzled (.x), which is how Three’s textureLoad( … ).x on the r32uint indirect table lands in one u32 property.

§

StorageLoad

storageTexture( t ).load( coord ) — textureLoad( t, coord ) on a texture_storage_*, which takes no level argument (WGSLNodeBuilder.generateStorageTextureLoad()).

Trait Implementations§

Source§

impl Clone for SampleMode

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SampleMode

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.