Struct three_d::core::render_target::RenderTarget

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

Adds additional functionality to clear, read from and write to the screen (see RenderTarget::screen) or a color texture and a depth texture at the same time (see RenderTarget::new). If you only want to perform an operation on either a color texture or depth texture, see ColorTarget and DepthTarget respectively. A render target purely adds functionality, so it can be created each time it is needed, the actual data is saved in the textures.

Implementations

impl<'a> RenderTarget<'a>

pub fn screen(context: &Context, width: u32, height: u32) -> Self

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

pub fn new(color: ColorTarget<'a>, depth: DepthTarget<'a>) -> ThreeDResult<Self>

Constructs a new render target that enables rendering into the given ColorTarget and DepthTarget.

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

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

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

Clears the color and depth of the part of this render 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 render 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 render target defined by the scissor box.

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

Returns the colors of the pixels in this render target. 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_color_partially<T: TextureDataType>(
    &self,
    scissor_box: ScissorBox
) -> ThreeDResult<Vec<T>>

Returns the colors of the pixels in this render target inside the given scissor box. 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) -> ThreeDResult<Vec<f32>>

Returns the depth values in this render target.

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

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

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

Copies the content of the color and depth texture to the specified scissor box 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)>,
    scissor_box: ScissorBox,
    write_mask: WriteMask
) -> ThreeDResult<&Self>

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.

pub fn scissor_box(&self) -> ScissorBox

Returns the scissor box that encloses the entire target.

impl<'a> RenderTarget<'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 render 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 render 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 Drop for RenderTarget<'_>

fn drop(&mut self)

Executes the destructor for this type.