luxe API (2025.1.2)

---

luxe: noise module

• Noise
• NoiseCellularDistanceFunc
• NoiseCellularReturnType
• NoiseDomainWarpType
• NoiseFractalType
• NoiseRotationType3D
• NoiseType

---

Noise

import "luxe: noise" for Noise

no docs found

• create(type: NoiseType)
• create(type: NoiseType, seed: Num)
• destroy(handle: Noise)
• valid(handle: Noise)
• get2D(handle: Noise, x: Num, y: Num)
• get3D(handle: Noise, x: Num, y: Num, z: Num)
• set_seed(handle: Noise, seed: Num)
• domain_warp2D(handle: Noise, x: Num, y: Num)
• domain_warp3D(handle: Noise, x: Num, y: Num, z: Num)
• set_rotation_type3D(handle: Noise, type: NoiseRotationType3D)
• set_fractal_type(handle: Noise, type: NoiseFractalType)
• set_fractal_octaves(handle: Noise, octaves: Num)
• set_fractal_lacunarity(handle: Noise, lacunarity: Num)
• set_fractal_gain(handle: Noise, gain: Num)
• set_fractal_weighted_strength(handle: Noise, weighted_strength: Num)
• set_fractal_ping_pong_strength(handle: Noise, ping_pong_strength: Num)
• set_cellular_distance_func(handle: Noise, distance_func: NoiseCellularDistanceFunc)
• set_cellular_return_type(handle: Noise, type: NoiseCellularReturnType)
• set_cellular_jitter(handle: Noise, jitter: Num)
• set_domain_warp_type(handle: Noise, type: NoiseDomainWarpType)
• set_domain_warp_amp(handle: Noise, amp: Num)

---

Noise.create(type: NoiseType) returns Noise

no docs found

Noise.create(type: NoiseType, seed: Num) returns Noise

no docs found

Noise.destroy(handle: Noise) returns None

no docs found

Noise.valid(handle: Noise) returns Bool

no docs found

Noise.get2D(handle: Noise, x: Num, y: Num) returns Num

no docs found

Noise.get3D(handle: Noise, x: Num, y: Num, z: Num) returns Num

no docs found

Noise.set_seed(handle: Noise, seed: Num) returns None

no docs found

Noise.domain_warp2D(handle: Noise, x: Num, y: Num) returns Vec2

no docs found

Noise.domain_warp3D(handle: Noise, x: Num, y: Num, z: Num) returns Vec3

no docs found

Noise.set_rotation_type3D(handle: Noise, type: NoiseRotationType3D) returns None

no docs found

Noise.set_fractal_type(handle: Noise, type: NoiseFractalType) returns None

no docs found

Noise.set_fractal_octaves(handle: Noise, octaves: Num) returns None

no docs found

Noise.set_fractal_lacunarity(handle: Noise, lacunarity: Num) returns None

no docs found

Noise.set_fractal_gain(handle: Noise, gain: Num) returns None

no docs found

Noise.set_fractal_weighted_strength(handle: Noise, weighted_strength: Num) returns None

no docs found

Noise.set_fractal_ping_pong_strength(handle: Noise, ping_pong_strength: Num) returns None

no docs found

Noise.set_cellular_distance_func(handle: Noise, distance_func: NoiseCellularDistanceFunc) returns None

no docs found

Noise.set_cellular_return_type(handle: Noise, type: NoiseCellularReturnType) returns None

no docs found

Noise.set_cellular_jitter(handle: Noise, jitter: Num) returns None

no docs found

Noise.set_domain_warp_type(handle: Noise, type: NoiseDomainWarpType) returns None

no docs found

Noise.set_domain_warp_amp(handle: Noise, amp: Num) returns None

no docs found

NoiseCellularDistanceFunc

import "luxe: noise" for NoiseCellularDistanceFunc

no docs found

• euclidean
• euclidean_sq
• manhattan
• hybrid

---

NoiseCellularDistanceFunc.euclidean returns unknown

no docs found

NoiseCellularDistanceFunc.euclidean_sq returns unknown

no docs found

NoiseCellularDistanceFunc.manhattan returns unknown

no docs found

NoiseCellularDistanceFunc.hybrid returns unknown

no docs found

NoiseCellularReturnType

import "luxe: noise" for NoiseCellularReturnType

no docs found

• cell_value
• distance
• distance2
• distance2_add
• distance2_sub
• distance2_mul
• distance2_div

---

NoiseCellularReturnType.cell_value returns unknown

no docs found

NoiseCellularReturnType.distance returns unknown

no docs found

NoiseCellularReturnType.distance2 returns unknown

no docs found

NoiseCellularReturnType.distance2_add returns unknown

no docs found

NoiseCellularReturnType.distance2_sub returns unknown

no docs found

NoiseCellularReturnType.distance2_mul returns unknown

no docs found

NoiseCellularReturnType.distance2_div returns unknown

no docs found

NoiseDomainWarpType

import "luxe: noise" for NoiseDomainWarpType

no docs found

• open_simplex2
• open_simplex2_reduced
• basic_grid

---

NoiseDomainWarpType.open_simplex2 returns unknown

no docs found

NoiseDomainWarpType.open_simplex2_reduced returns unknown

no docs found

NoiseDomainWarpType.basic_grid returns unknown

no docs found

NoiseFractalType

import "luxe: noise" for NoiseFractalType

no docs found

• none
• fbm
• ridged
• pingpong
• domain_warp_progressive
• domain_warp_independent

---

NoiseFractalType.none returns unknown

no docs found

NoiseFractalType.fbm returns unknown

no docs found

NoiseFractalType.ridged returns unknown

no docs found

NoiseFractalType.pingpong returns unknown

no docs found

NoiseFractalType.domain_warp_progressive returns unknown

no docs found

NoiseFractalType.domain_warp_independent returns unknown

no docs found

NoiseRotationType3D

import "luxe: noise" for NoiseRotationType3D

no docs found

• none
• improve_xy_planes
• improve_xz_planes

---

NoiseRotationType3D.none returns unknown

no docs found

NoiseRotationType3D.improve_xy_planes returns unknown

no docs found

NoiseRotationType3D.improve_xz_planes returns unknown

no docs found

NoiseType

import "luxe: noise" for NoiseType

no docs found

• open_simplex2
• open_simplex2s
• cellular
• perlin
• value_cubic
• value

---

NoiseType.open_simplex2 returns unknown

no docs found

NoiseType.open_simplex2s returns unknown

no docs found

NoiseType.cellular returns unknown

no docs found

NoiseType.perlin returns unknown

no docs found

NoiseType.value_cubic returns unknown

no docs found

NoiseType.value returns unknown

no docs found