Struct three_d::core::texture::ColorTargetTexture2D

pub struct ColorTargetTexture2D<T: TextureDataType> {
    pub transparent: bool,
    // some fields omitted
}

A 2D color texture that can be rendered into and read from.

Note: DepthTest is disabled if not also writing to a depth texture. Use a RenderTarget to write to both color and depth.

Fields

transparent: bool

Set this to true if you want to render some geometry with this texture and the texture contain alpha values and those alpha values are below maximum.

Implementations

impl<T: TextureDataType> ColorTargetTexture2D<T>

pub fn new(
    context: &Context,
    width: u32,
    height: u32,
    min_filter: Interpolation,
    mag_filter: Interpolation,
    mip_map_filter: Option<Interpolation>,
    wrap_s: Wrapping,
    wrap_t: Wrapping,
    format: Format
) -> ThreeDResult<Self>

Constructs a new 2D color target texture.

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

Renders whatever rendered in the render closure into the texture. Before writing, the texture is cleared based on the given clear state.

Note: DepthTest is disabled if not also writing to a depth texture. Use a RenderTarget to write to both color and depth.

pub fn copy_to(
    &self,
    destination: CopyDestination<'_, '_, '_, '_, T>,
    viewport: Viewport,
    write_mask: WriteMask
) -> ThreeDResult<()>

Copies the content of the color texture to the specified destination at the given viewport. Will only copy the channels specified by the write mask.

Errors

Will return an error if the destination is a depth texture.

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

Returns the color values of the pixels in this color texture inside the given viewport.

Note: Only works for the RGBA format.

Errors

Will return an error if the color texture is not RGBA format.

Trait Implementations

impl<T: TextureDataType> Drop for ColorTargetTexture2D<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: TextureDataType> Texture for ColorTargetTexture2D<T>

fn bind(&self, location: u32)

Binds this texture to the current shader program.

fn width(&self) -> u32

The width of this texture.

fn height(&self) -> u32

The height of this texture.

fn format(&self) -> Format

The format of this texture.

fn is_transparent(&self) -> bool

Whether this texture contain pixels with alpha value less than maximum.