Skip to main content

VolumeRenderParams

Struct VolumeRenderParams 

Source
pub struct VolumeRenderParams {
    pub color_tf: ColorTransferFunction,
    pub opacity_tf: OpacityTransferFunction,
    pub gradient_opacity_tf: Option<OpacityTransferFunction>,
    pub window_level: Option<WindowLevel>,
    pub blend_mode: BlendMode,
    pub interpolation: Interpolation,
    pub shading: Option<ShadingParams>,
    pub step_size_factor: f32,
    pub clip_planes: Vec<ClipPlane>,
    pub cropping_bounds: Option<Aabb>,
    pub background: [f32; 4],
}
Expand description

All parameters that control how a volume is rendered.

Built using a fluent builder pattern. Start from VolumeRenderParams::builder or use VolumeRenderParams::default.

Fields§

§color_tf: ColorTransferFunction

Colour transfer function.

§opacity_tf: OpacityTransferFunction

Opacity transfer function.

§gradient_opacity_tf: Option<OpacityTransferFunction>

Optional gradient opacity modulation.

§window_level: Option<WindowLevel>

Window/level mapping (applied before TF lookup).

§blend_mode: BlendMode

Compositing algorithm.

§interpolation: Interpolation

Texture interpolation quality.

§shading: Option<ShadingParams>

Phong shading — only used in BlendMode::Composite and BlendMode::Isosurface.

§step_size_factor: f32

Raycasting step size as a fraction of the smallest voxel spacing (default 0.5).

§clip_planes: Vec<ClipPlane>

Up to 6 world-space clip planes.

§cropping_bounds: Option<Aabb>

Optional axis-aligned cropping box in world coordinates.

§background: [f32; 4]

Background colour RGBA in [0, 1].

Implementations§

Source§

impl VolumeRenderParams

Source

pub fn builder() -> VolumeRenderParamsBuilder

Start building a new parameter set from the defaults.

Trait Implementations§

Source§

impl Clone for VolumeRenderParams

Source§

fn clone(&self) -> VolumeRenderParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VolumeRenderParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VolumeRenderParams

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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> 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 = 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.