Skip to main content

VoxelRenderConfig

Struct VoxelRenderConfig 

Source
pub struct VoxelRenderConfig<'a> {
    pub image_size: VoxelSize,
    pub world_to_model: Matrix4<f32>,
    pub tile_sizes: TileSizes,
    pub threads: Option<&'a ThreadPool>,
    pub cancel: CancelToken,
}
Expand description

Settings for 3D rendering

Fields§

§image_size: VoxelSize

Render size

The resulting image will have the given width and height; depth sets the number of voxels to evaluate within each pixel of the image (stacked into a column going into the screen).

§world_to_model: Matrix4<f32>

World-to-model transform

§tile_sizes: TileSizes

Tile sizes to use during evaluation.

You’ll likely want to use RenderHints::tile_sizes_3d to select this based on evaluator type.

§threads: Option<&'a ThreadPool>

Thread pool to use for rendering

If this is None, then rendering is done in a single thread; otherwise, the provided pool is used.

§cancel: CancelToken

Token to cancel rendering

Implementations§

Source§

impl VoxelRenderConfig<'_>

Source

pub fn run<F: Function>(&self, shape: Shape<F>) -> Option<GeometryBuffer>

Render a shape in 3D using this configuration

Returns a GeometryBuffer of pixel data, or None if rendering was cancelled.

In the resulting image, saturated pixels (i.e. pixels in the image which are fully occupied up to the camera) are represented with depth = self.image_size.depth() and a normal of [0, 0, 1].

Source

pub fn run_with_vars<F: Function>( &self, shape: Shape<F>, vars: &ShapeVars<f32>, ) -> Option<GeometryBuffer>

Render a shape in 3D using this configuration and variables

Source

pub fn mat(&self) -> Matrix4<f32>

Returns the combined screen-to-model transform matrix

Trait Implementations§

Source§

impl Default for VoxelRenderConfig<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for VoxelRenderConfig<'a>

§

impl<'a> !RefUnwindSafe for VoxelRenderConfig<'a>

§

impl<'a> Send for VoxelRenderConfig<'a>

§

impl<'a> Sync for VoxelRenderConfig<'a>

§

impl<'a> Unpin for VoxelRenderConfig<'a>

§

impl<'a> UnsafeUnpin for VoxelRenderConfig<'a>

§

impl<'a> !UnwindSafe for VoxelRenderConfig<'a>

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.