Struct three_d::core::texture::Texture2D

pub struct Texture2D<T: TextureDataType> { /* fields omitted */ }

A 2D texture, basically an image that is transferred to the GPU.

Implementations

impl<T: TextureDataType> Texture2D<T>

pub fn new(
    context: &Context,
    cpu_texture: &CPUTexture<T>
) -> ThreeDResult<Texture2D<T>>

Construcs a new texture with the given data.

pub fn new_empty(
    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 empty 2D texture.

pub fn fill(&mut self, data: &[T]) -> ThreeDResult<()>

Fills this texture with the given data.

Errors

Return an error if the length of the data array is smaller or bigger than the necessary number of bytes to fill the entire texture.

pub fn write<F: FnOnce() -> ThreeDResult<()>>(
    &mut 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(
    &mut self,
    destination: CopyDestination<'_, '_, '_, '_, T>,
    viewport: Viewport,
    write_mask: WriteMask
) -> ThreeDResult<()>

👎 Deprecated:

Use RenderTarget::copy_from or Screen::copy_from instead

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 Texture2D<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: TextureDataType> Texture for Texture2D<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.