Struct three_d::core::render_target::RenderTarget

pub struct RenderTarget<'a, 'b> { /* private fields */ }

Adds additional functionality to write to and copy from both a ColorTargetTexture2D and a DepthTargetTexture2D at the same time. It purely adds functionality, so it can be created each time it is needed, the data is saved in the textures.

Implementations

impl<'a, 'b> RenderTarget<'a, 'b>

pub fn screen(context: &Context) -> ThreeDResult<Self>

Returns the screen render target for this context. Write to this render target to draw something on the screen.

pub fn new_depth(
    context: &Context,
    depth_texture: &'b mut DepthTargetTexture2D
) -> ThreeDResult<Self>

Constructs a new render target that enables rendering into the given DepthTargetTexture2D.

pub fn new(
    context: &Context,
    color_texture: &'a mut Texture2D,
    depth_texture: &'b mut DepthTargetTexture2D
) -> ThreeDResult<Self>

Constructs a new render target that enables rendering into the given ColorTargetTexture2D and DepthTargetTexture2D textures.

pub fn new_color(
    context: &Context,
    color_texture: &'a mut Texture2D
) -> ThreeDResult<Self>

Constructs a new render target that enables rendering into the given ColorTargetTexture2D.

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

Renders whatever rendered in the render closure into the textures defined at construction. Before writing, the textures are cleared based on the given clear state.

pub fn read_color<T: TextureDataType>(
    &self,
    viewport: Viewport
) -> ThreeDResult<Vec<T>>

Returns the values of the pixels in this texture inside the given viewport. The number of channels per pixel and the data format for each channel is specified by the generic parameter.

Note: On web, the data format needs to match the data format of the color texture.

pub fn read_depth(&self, viewport: Viewport) -> ThreeDResult<Vec<f32>>

Returns the depth values from the screen as a list of 32-bit floats. Only available on desktop.

pub fn copy_from(
    &self,
    color_texture: Option<&Texture2D>,
    depth_texture: Option<&DepthTargetTexture2D>,
    viewport: Viewport,
    write_mask: WriteMask
) -> ThreeDResult<()>

Copies the content of the color and depth texture to the specified viewport of this render target. Only copies the channels given by the write mask.

pub fn copy_from_array(
    &self,
    color_texture: Option<(&Texture2DArray, u32)>,
    depth_texture: Option<(&DepthTargetTexture2DArray, u32)>,
    viewport: Viewport,
    write_mask: WriteMask
) -> ThreeDResult<()>

Copies the content of the given layers of the color and depth array textures to the specified viewport of this render target. Only copies the channels given by the write mask.

Trait Implementations

impl Drop for RenderTarget<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.