API reference

aster_blueprint::noise_nodes

Pre-1.0: signatures are not frozen. Generated from rustdoc JSON of the compiled crate; rustdoc JSON format version 60. Only public items are listed.

The core.noise.*.v1 graph nodes: noise as typed, pure data kernels.

  • Samplers (Scalar out, always 0..=1; Domain::Pure): feed the output into any Scalar input (core.scalar.multiply, core.color.mix's t, an opacity, a length via core.length.scale) to drive positions, colours and opacity. x/y are in noise space: multiply screen coordinates yourself or use the frequency port (features per unit).
  • Time-animated samplers take a time: Seconds port. Wire core.clock.v1 into it and the graph is clock-tainted exactly like any other clock consumer (the host must supply a clock; without one the evaluation is refused with ClockUnavailable).
  • Surfaces (Drawing out; Domain::Visual): a noise field through a colour ramp at reduced resolution, an aurora gradient, and film grain.

All kernels are deterministic and bit-identical across platforms ([crate::noise] documents the guarantee). Octave counts are clamped to 1..=12; surface sizes are limited to [crate::noise_surface::MAX_EDGE].

Structs

structaster_blueprint::noise_nodes::NoisePort

pub struct NoisePort { /* see fields */ }

One declared input: name, type and optional default.

Public fields

fieldtype
name&'static str
value_typemodel::ValueType
defaultOption<model::Literal>

Trait implementations: Clone, Debug

Enums

enumaster_blueprint::noise_nodes::NoiseNode

pub enum NoiseNode { Value, Perlin, Simplex, Simplex3, Cellular, Fbm, Ridged, Turbulence, Warp, Animated, AnimatedWarp, Surface, Aurora, Grain }

One noise node kind.

Methods

  • const ALL: [NoiseNode; 14] — Every noise node, in catalog order.
  • fn name(self) -> &'static str
  • fn from_name(name: &str) -> Option<Self>
  • fn output(self) -> ValueType — Drawing for surfaces, Scalar for samplers.
  • fn domain(self) -> Domain
  • fn inputs(self) -> Vec<NoisePort> — Declared inputs in port order (this table is also the runtime's check).
  • fn definition(self) -> Definition — The catalog definition.
  • fn evaluate(self, args: &[RuntimeValue]) -> Result<RuntimeValue, Error> — Evaluate against type-admitted inputs in declared port order. A bad shape is Error::InvalidGeometry; octaves/gain/lacunarity are clamped.

Variants

  • Value
  • Perlin
  • Simplex
  • Simplex3
  • Cellular
  • Fbm
  • Ridged
  • Turbulence
  • Warp
  • Animated
  • AnimatedWarp
  • Surface
  • Aurora
  • Grain

Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq

Constants

constaster_blueprint::noise_nodes::ANIMATED

pub const ANIMATED: &str

constaster_blueprint::noise_nodes::ANIMATED_WARP

pub const ANIMATED_WARP: &str

constaster_blueprint::noise_nodes::AURORA

pub const AURORA: &str

constaster_blueprint::noise_nodes::CELLULAR

pub const CELLULAR: &str

constaster_blueprint::noise_nodes::FBM

pub const FBM: &str

constaster_blueprint::noise_nodes::GRAIN

pub const GRAIN: &str

constaster_blueprint::noise_nodes::PERLIN

pub const PERLIN: &str

constaster_blueprint::noise_nodes::RIDGED

pub const RIDGED: &str

constaster_blueprint::noise_nodes::SIMPLEX

pub const SIMPLEX: &str

constaster_blueprint::noise_nodes::SIMPLEX3

pub const SIMPLEX3: &str

constaster_blueprint::noise_nodes::SURFACE

pub const SURFACE: &str

constaster_blueprint::noise_nodes::TURBULENCE

pub const TURBULENCE: &str

constaster_blueprint::noise_nodes::VALUE

pub const VALUE: &str

constaster_blueprint::noise_nodes::WARP

pub const WARP: &str