Struct screen_13::gpu::Gpu

pub struct Gpu { /* fields omitted */ }

Allows you to load resources and begin rendering operations.

Implementations

impl Gpu

pub fn offscreen() -> Self

Creates a Gpu for off-screen or headless use.

NOTE: Resources loaded or read from a Gpu created in headless or screen modes cannot be used with other instances, including of the same mode. This is a limitation only because the code to share the resources properly has not be started yet.

pub fn load_bitmap(
    &self,
    pixel_ty: BitmapFormat,
    pixels: &[u8],
    width: u32,
    stride: u32
) -> Bitmap

Loads a bitmap at runtime from the given data.

pub fn load_indexed_model<M: IntoIterator<Item = Mesh>, I: IntoIterator<Item = u32>, V: IntoIterator<Item = VV>, VV: Copy + Into<Vertex>>(
    &self,
    meshes: M,
    _indices: I,
    _vertices: V
) -> Result<Model, BadData>

Loads an indexed model at runtime from the given data.

pub fn load_model<IM: IntoIterator<Item = M>, IV: IntoIterator<Item = V>, M: Into<Mesh>, V: Copy + Into<Vertex>>(
    &self,
    meshes: IM,
    vertices: IV
) -> Result<Model, BadData>

Loads a regular model at runtime from the given data.

pub fn read_animation<R: Read + Seek>(
    &self,
    _name: &str,
    _pak: &mut Pak<R>,
    _id: AnimationId
) -> ModelRef

Reads the Animation with the given id from the pak.

pub fn read_bitmap<K: AsRef<str>, R: Read + Seek>(
    &self,
    pak: &mut Pak<R>,
    key: K
) -> Bitmap

Reads the Bitmap with the given key from the pak.

pub fn read_bitmap_with_id<R: Read + Seek>(
    &self,
    pak: &mut Pak<R>,
    id: BitmapId
) -> Bitmap

Reads the Bitmap with the given id from the pak.

pub fn read_font<F: AsRef<str>, R: Read + Seek>(
    &self,
    pak: &mut Pak<R>,
    face: F
) -> Font

Reads the Font with the given face from the pak.

Only bitmapped fonts are supported.

pub fn read_model<K: AsRef<str>, R: Read + Seek>(
    &self,
    pak: &mut Pak<R>,
    key: K
) -> Model

Reads the Model with the given key from the pak.

pub fn read_model_with_id<R: Read + Seek>(
    &self,
    pak: &mut Pak<R>,
    id: ModelId
) -> Model

Reads the Model with the given id from the pak.

pub fn render<D: Into<Extent>>(&self, dims: D) -> Render

Constructs a Render of the given dimensions.

NOTE: This function uses an internal cache.

Examples:

use screen_13::prelude_all::*;

struct Foo;

impl Screen for Foo {
    fn render(&self, gpu: &Gpu, dims: Extent) -> Render {
        let frame = gpu.render(dims);

        ...
    }

    ...
}

pub fn render_with_cache<D: Into<Extent>>(
    &self,
    dims: D,
    cache: &Cache
) -> Render

Constructs a Render of the given dimensions, using the provided cache.

Examples:

use screen_13::prelude_all::*;

#[derive(Default)]
struct Foo(Cache);

impl Screen for Foo {
    fn render(&self, gpu: &Gpu, dims: Extent) -> Render {
        let cache = &self.0;
        let frame = gpu.render(dims, cache);

        ...
    }

    ...
}

pub fn resolve(&self, render: Render) -> Lease<Texture2d>

Resolves a render into a texture which can be written to other renders.

Trait Implementations

impl Drop for Gpu

pub fn drop(&mut self)

Executes the destructor for this type.