Struct three_d::core::render_target::DepthTarget

pub struct DepthTarget<'a> { /* private fields */ }

Adds additional functionality to clear, read from and write to a texture. Use the as_depth_target function directly on the texture structs (for example DepthTargetTexture2D) to construct a depth target. Combine this together with a ColorTarget with RenderTarget::new to be able to write to both a depth and color target at the same time. A depth target purely adds functionality, so it can be created each time it is needed, the actual data is saved in the texture.

Implementations

impl<'a> DepthTarget<'a>

pub fn clear(&self, clear_state: ClearState) -> ThreeDResult<&Self>

Clears the depth of this depth target as defined by the given clear state.

pub fn clear_partially(
    &self,
    scissor_box: ScissorBox,
    clear_state: ClearState
) -> ThreeDResult<&Self>

Clears the depth of the part of this depth target that is inside the given scissor box.

pub fn write(
    &self,
    render: impl FnOnce() -> ThreeDResult<()>
) -> ThreeDResult<&Self>

Writes whatever rendered in the render closure into this depth target.

pub fn write_partially(
    &self,
    scissor_box: ScissorBox,
    render: impl FnOnce() -> ThreeDResult<()>
) -> ThreeDResult<&Self>

Writes whatever rendered in the render closure into the part of this depth target defined by the scissor box.

pub fn read(&self) -> ThreeDResult<Vec<f32>>

Returns the depth values in this depth target.

pub fn read_partially(&self, scissor_box: ScissorBox) -> ThreeDResult<Vec<f32>>

Returns the depth values in this depth target inside the given scissor box.

pub fn width(&self) -> u32

Returns the width of the depth target in texels, which is simply the width of the underlying texture.

pub fn height(&self) -> u32

Returns the height of the depth target in texels, which is simply the height of the underlying texture.

pub fn scissor_box(&self) -> ScissorBox

Returns the scissor box that encloses the entire target.

impl<'a> DepthTarget<'a>

pub fn render(
    &self,
    camera: &Camera,
    objects: &[&dyn Object],
    lights: &[&dyn Light]
) -> ThreeDResult<&Self>

Render the objects using the given camera and lights into this depth target. Use an empty array for the lights argument, if the objects does not require lights to be rendered. Also, objects outside the camera frustum are not rendered and the objects are rendered in the order given by cmp_render_order.

pub fn render_partially(
    &self,
    scissor_box: ScissorBox,
    camera: &Camera,
    objects: &[&dyn Object],
    lights: &[&dyn Light]
) -> ThreeDResult<&Self>

Render the objects using the given camera and lights into the part of this depth target defined by the scissor box. Use an empty array for the lights argument, if the objects does not require lights to be rendered. Also, objects outside the camera frustum are not rendered and the objects are rendered in the order given by cmp_render_order.

Trait Implementations

impl<'a> Clone for DepthTarget<'a>

fn clone(&self) -> DepthTarget<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.