Struct three_d::core::texture::Texture2D

pub struct Texture2D { /* private fields */ }

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

Implementations

impl Texture2D

pub fn new(context: &Context, cpu_texture: &CpuTexture) -> ThreeDResult<Self>

Construcs a new texture with the given data.

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

Constructs a new empty 2D texture with the given parameters. The format is determined by the generic TextureDataType parameter (for example, if [u8; 4] is specified, the format is RGBA and the data type is byte).

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

Fills this texture with the given data.

Errors

Returns an error if the length of the data does not correspond to the width, height and format specified at construction. It is therefore necessary to create a new texture if the texture size or format has changed.

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 read<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 this texture.

pub fn width(&self) -> u32

The width of this texture.

pub fn height(&self) -> u32

The height of this texture.

Trait Implementations

impl Drop for Texture2D

fn drop(&mut self)

Executes the destructor for this type.