Struct SpritesheetBuilder 

pub struct SpritesheetBuilder {
    pub image: Option<Image>,
    pub shaders: Shaders,
    pub alpha_blending: AlphaBlending,
    pub minification_smoothing: bool,
    pub magnification_smoothing: bool,
    pub wrap: (TextureWrapping, TextureWrapping),
    pub srgb: bool,
}

A builder for Spritesheet.

Fields

image: Option<Image>

The texture used when drawing with this handle. None can be used if you want to just draw flat-color quads.

shaders: Shaders

The shaders used when drawing with this handle.

alpha_blending: AlphaBlending

Whether to blend with previously drawn pixels when drawing over them, or just replace the color. Rule of thumb: if the sprites only use alpha values of 0 and 255 (ie. fully transparent and fully opaque), set this to false, and true otherwise. In any case, alpha values of less than 1/256 will be cut out and won’t be rendered at all.

Internally, this controls whether GL_BLEND and back-to-front sorting are enabled.

minification_smoothing: bool

When drawing quads that are smaller than the texture provided, use linear (true) or nearest neighbor (false) smoothing when scaling? (Linear is probably always better.)

magnification_smoothing: bool

When drawing quads that are larger than the texture provided, use linear (true) or nearest neighbor (false) smoothing when scaling? (Tip: for pixel art or other textures that don’t suffer from jaggies, set this to false for the intended look.)

wrap: (TextureWrapping, TextureWrapping)

Sets the texture’s behavior when sampling coordinates under 0.0 or over 1.0, or smoothing over texture boundaries. (Corresponds to GL_TEXTURE_WRAP_S and GL_TEXTURE_WRAP_T, in that order.)

srgb: bool

Controls whether the colors rendered by this draw call should be converted into sRGB before display. This should generally be true, unless you handle gamma in your shaders yourself. Note that in any case, the fragment shader will process fragments in linear space: this conversion happens after blending.

Internally, this controls whether or not GL_FRAMEBUFFER_SRGB is enabled when drawing with this handle.

Implementations

impl SpritesheetBuilder

pub fn build(&self, ctx: &mut Context) -> Spritesheet

Creates a new Spritesheet from this builder.

pub fn image(&mut self, image: Image) -> &mut SpritesheetBuilder

Sets the spritesheet’s texture.

pub fn shaders(&mut self, shaders: Shaders) -> &mut SpritesheetBuilder

Sets the spritesheet’s shaders.

pub fn alpha_blending( &mut self, blend: bool, sort: bool, ) -> &mut SpritesheetBuilder

Toggles the spritesheet’s alpha blending.

pub fn minification_smoothing( &mut self, smoothing: bool, ) -> &mut SpritesheetBuilder

Sets the spritesheet’s minification filter.

pub fn magnification_smoothing( &mut self, smoothing: bool, ) -> &mut SpritesheetBuilder

Sets the spritesheet’s magnification filter.

pub fn wrapping_behavior( &mut self, wrap_s: TextureWrapping, wrap_t: TextureWrapping, ) -> &mut SpritesheetBuilder

Sets the spritesheet texture’s wrapping behavior.

pub fn srgb(&mut self, srgb: bool) -> &mut SpritesheetBuilder

Toggles the srgb-ness of the draw call.

Trait Implementations

impl Clone for SpritesheetBuilder

fn clone(&self) -> SpritesheetBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SpritesheetBuilder

fn default() -> SpritesheetBuilder

Returns the “default value” for a type.