Struct lotus_script::graphics::textures::Texture

pub struct Texture(/* private fields */);

A texture that can be manipulated and displayed on script texture slots.

Implementations

impl Texture

pub fn create<'a>(options: impl Into<TextureCreationOptions<'a>>) -> Self

Create a new texture.

pub fn add_action(&mut self, action: TextureAction)

Add an action to the texture. You may want to call the helper methods instead of this.

pub fn draw_rect( &mut self, start: impl Into<UVec2>, end: impl Into<UVec2>, color: Color )

Draw a rectangle on the texture.

pub fn clear(&mut self, color: Color)

Clear the texture with a color.

pub fn read_pixel(&self, x: u32, y: u32) -> Color

Read the color of a pixel on the texture.

pub fn draw_pixels<P>(&mut self, pixels: &[P])

where P: Into<DrawPixel> + Copy,

Draw multiple pixels on the texture.

pub fn draw_texture(&mut self, other: &Texture, options: DrawTextureOpts)

Draws another texture on top of this one.

pub fn apply_to(&mut self, name: &str)

Call this once for every game-texture you want to apply this to. You can define the name in the content tool.

pub fn flush(&mut self) -> bool

Only call this if you need your actions to be applied immediately. Cause of streaming assets, this method will return false if the actions are not yet applied. Just call this method again until it returns true.

pub fn draw_script_texture(&mut self, other: &Texture, options: DrawTextureOpts)

Draws another texture on top of this one.

pub fn draw_text( &mut self, font: ContentId, text: impl Into<String>, top_left: impl Into<UVec2>, letter_spacing: u32, full_color: impl Into<Option<Color>>, alpha_mode: AlphaMode )

Draws a text on the texture.

pub fn handle(&self) -> TextureHandle

Get the handle of the texture.

pub fn forget(self)

Forget the texture. This means it will not be disposed when the texture is dropped. Use this only if you want to keep the texture alive without keeping a reference to it.

Trait Implementations

impl Debug for Texture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Texture

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Texture> for DrawableTexture

fn from(texture: &Texture) -> Self

Converts to this type from the input type.