Struct Image

pub struct Image {

    pub pos: Vec3,
    pub hw: Vec2,
    pub uv: Vec4,
    pub color: Color,
    pub frames: Vec2,
    pub switch_time: u32,
    pub animate: bool,
    pub camera_type: CameraType,
    pub texture: Option<usize>,
    pub store_id: Index,
    pub order: DrawOrder,
    pub render_layer: u32,
    pub bounds: Option<Bounds>,
    pub flip_style: FlipStyle,
    pub rotation_angle: f32,
    pub order_override: Option<Vec3>,
    pub changed: bool,
}

Basic and Fast Image Rendering Type. Best used for Sprites and Objects in the world.

Fields

pos: Vec3

Position of the object

hw: Vec2

Height and Width

uv: Vec4

Static texture offsets or animation frame positions

color: Color

Color.

frames: Vec2

frames, frames_per_row: this will cycle thru frames per row at the uv start.

switch_time: u32

in millsecs 1000 = 1sec

animate: bool

turn on animation if set.

camera_type: CameraType

Global Camera the Shader will use to render the object with

texture: Option<usize>

Texture area location in Atlas.

store_id: Index

Buffer’s store Index.

order: DrawOrder

Ordering Type, used to order the Stores in the buffers.

render_layer: u32

Layer this type is rendering on.

bounds: Option<Bounds>

Clip bounds if enabled in the renderer.

flip_style: FlipStyle

Directional Flip.

rotation_angle: f32

direct angle of rotation from the center Axis.

order_override: Option<Vec3>

Overides the absolute order values based on position.

changed: bool

When true tells system to update the buffers.

Implementations

impl Image

pub fn new( texture: Option<usize>, renderer: &mut GpuRenderer, render_layer: u32, ) -> Self

Creates a new Image with rendering layer.

pub fn unload(&self, renderer: &mut GpuRenderer)

Unloads the Image from the Instance Buffers Store.

pub fn set_order_override(&mut self, order_override: Option<Vec3>) -> &mut Self

Updates the Image’s order_override.

pub fn update_bounds(&mut self, bounds: Option<Bounds>) -> &mut Self

Updates the Image’s Optional Clipping Bounds.

pub fn set_flip_style(&mut self, flip_style: FlipStyle) -> &mut Self

Updates the Image’s FlipStyle.

pub fn set_rotation_angle(&mut self, rotation_angle: f32) -> &mut Self

Updates the Image’s rotation.

pub fn set_pos(&mut self, pos: Vec3) -> &mut Self

Updates the Image’s position.

pub fn set_size(&mut self, hw: Vec2) -> &mut Self

Updates the Image’s width and height.

pub fn set_frames(&mut self, frames: Vec2) -> &mut Self

Updates the Image’s animation frames.

pub fn set_animate(&mut self, animate: bool) -> &mut Self

Updates the Image’s animate boolean.

pub fn set_uv(&mut self, uv: Vec4) -> &mut Self

Updates the Image’s texture x, y, w, h

pub fn set_render_layer(&mut self, render_layer: u32) -> &mut Self

Updates the Image’s rendering layer.

pub fn set_texture(&mut self, texture: Option<usize>) -> &mut Self

Updates the Image’s Texture ID.

pub fn set_color(&mut self, color: Color) -> &mut Self

Updates the Image’s Color.

pub fn set_camera_type(&mut self, camera_type: CameraType) -> &mut Self

Updates the Image’s CameraType.

pub fn set_switch_time(&mut self, switch_time: u32) -> &mut Self

Updates the Image’s animation switch time.

pub fn update( &mut self, renderer: &mut GpuRenderer, atlas: &mut AtlasSet, ) -> OrderedIndex

Used to check and update the vertex array. Returns a OrderedIndex used in Rendering.