Struct Rect

pub struct Rect {

    pub position: Vec3,
    pub size: Vec2,
    pub color: Color,
    pub image: Option<usize>,
    pub uv: Vec4,
    pub border_width: f32,
    pub border_color: Color,
    pub radius: f32,
    pub camera_type: CameraType,
    pub store_id: Index,
    pub order: DrawOrder,
    pub render_layer: u32,
    pub bounds: Option<Bounds>,
    pub order_override: Option<Vec3>,
    pub changed: bool,
}

Rectangle to render to screen. Can contain a Images otherwise just colors.

Fields

position: Vec3

Position on the Screen.

size: Vec2

Width and Height of the Rect.

color: Color

Color of the Rect.

image: Option<usize>

Optional Image Index.

uv: Vec4

Texture X, Y, W and H if any apply.

border_width: f32

Width of the Rects Border.

border_color: Color

Color of the Rects Border.

radius: f32

Rectangle Radius.

camera_type: CameraType

CameraType used to render with.

store_id: Index

Instance Buffers Store ID.

order: DrawOrder

the draw order of the rect. created/updated when update is called.

render_layer: u32

Rendering Layer of the rect used in DrawOrder.

bounds: Option<Bounds>

Optional Bounds for Clipping the Rect too.

order_override: Option<Vec3>

Overides the absolute order values based on position.

changed: bool

If anything got updated we need to update the buffers too.

Implementations

impl Rect

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

Creates a new Rect with rendering layer.

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

Unloads the Rect from the Instance Buffers Store.

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

Updates the Rect’s order_override.

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

Updates the Rect’s Clipping Bounds.

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

Sets the Rect’s CameraType for rendering.

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

Sets the Rect’s Color.

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

Sets the Rect’s Border Color.

pub fn set_texture( &mut self, renderer: &GpuRenderer, atlas: &mut AtlasSet, path: String, ) -> Result<&mut Self, GraphicsError>

Sets the Rect’s Texture.

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

Sets the Rect’s Texture X,Y, W, H details.

pub fn set_position(&mut self, position: Vec3) -> &mut Self

Sets the Rect’s Position.

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

Sets the Rect’s Width and Height.

pub fn set_border_width(&mut self, size: f32) -> &mut Self

Sets the Rect’s Border Width.

pub fn set_radius(&mut self, radius: f32) -> &mut Self

Sets the Rect’s Corner Radius.

pub fn create_quad(&mut self, renderer: &mut GpuRenderer, atlas: &mut AtlasSet)

Updates the Rect’s Buffers to prepare them for rendering.

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.

pub fn check_mouse_bounds(&self, mouse_pos: Vec2) -> bool

Checks if the Mouse position is within the Rects location.