Struct vxdraw::VxDraw

pub struct VxDraw { /* fields omitted */ }

Main structure that holds all vulkan draw states

VxDraw is the entry-point of the library, from here all resources are spawned and managed.

This structure can safely be dropped and all associated resources will be cleaned up correctly.

Methods

impl VxDraw

pub fn new(log: Logger, show: ShowWindow) -> VxDraw

Spawn a new VxDraw context with a window

This method sets up all that is necessary for drawing.

pub fn set_perspective(&mut self, perspective: Matrix4<f32>)

Set the perspective to be used when drawing geometry

pub fn to_world_coords(&self, screen_coord: (f32, f32)) -> (f32, f32)

Translate a pixel to the world coordinates according to the current perspective

To set the current perspective see VxDraw::set_perspective.

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

Set the clear color when clearing a frame

pub fn buffer_count(&self) -> usize

Get how many swapchain images there exist

2 indicates double-buffering, 3 triple-buffering. May return 1 in the case of an OpenGL backend.

pub fn swap_layers(&mut self, layer1: &impl Layerable, layer2: &impl Layerable)

Swap two layer orders

pub fn get_window_size_in_pixels(&self) -> (u32, u32)

Get the size of the display window in floats

pub fn get_window_size_in_pixels_float(&self) -> (f32, f32)

Get the size of the display window in floats

pub fn set_window_size(&mut self, size: (u32, u32))

Set the size of the display window

pub fn debtri(&mut self) -> Debtri

Get a handle to all debug triangles, allows editing, removal, or creation of debtris See debtri::Debtri for more details.

pub fn quads(&mut self) -> Quads

Get a handle to all quads, allows editing, removal, or creation of new quads and layers. See quads::Quads for more details.

pub fn dyntex(&mut self) -> Dyntex

Get a handle to all dynamic textures, allows editing, removal, or creation of new dynamic textures. See dyntex::Dyntex for more details.

pub fn strtex(&mut self) -> Strtex

Get a handle to all streaming textures, allows editing, removal, or creation of new streaming textures. See strtex::Strtex for more details.

pub fn text(&mut self) -> Texts

Drawing text

pub fn collect_input(&mut self) -> Vec<Event>

Collect all pending input events to this window

pub fn draw_frame_copy_framebuffer(&mut self) -> Vec<u8>

Draw a frame but also copy the resulting image out

pub fn draw_frame(&mut self)

Draw a single frame and present it to the screen

The view matrix is used to translate all elements on the screen with the exception of debug triangles and layers that have their own view.

pub fn perspective_projection(&self) -> Matrix4<f32>

Generate the perspective projection so that the window's size does not stretch its elements. This perspective clamps the shorter axis to -1..1 and the longer axis to whatever its aspect ratio is.

This means that a window wider than tall will show a little more on the left and right edges instead of stretching the image to fill the window.

Trait Implementations

impl Drop for VxDraw

fn drop(&mut self)

Executes the destructor for this type.