Struct tetra::graphics::CanvasBuilder [−][src]
pub struct CanvasBuilder { /* fields omitted */ }
Expand description
A builder for creating advanced canvas configurations.
By default, Tetra’s canvases are fairly simple - they just provide a Texture
that you
can render things to. However, they can also be configured with extra features via this
builder, such as multisampling and additional buffers.
Implementations
impl CanvasBuilder
[src]
impl CanvasBuilder
[src]pub fn new(width: i32, height: i32) -> CanvasBuilder
[src]
pub fn new(width: i32, height: i32) -> CanvasBuilder
[src]Creates a new canvas builder, which can be used to create a canvas with multisampling and/or additional buffers.
You can also use Canvas::builder
as a shortcut for this, if you want
to avoid the extra import.
pub fn samples(&mut self, samples: u8) -> &mut CanvasBuilder
[src]
pub fn samples(&mut self, samples: u8) -> &mut CanvasBuilder
[src]Sets the level of multisample anti-aliasing to use.
The number of samples that can be used varies between graphics cards - 2
, 4
and 8
are reasonably
well supported. When set to 0
(the default), no multisampling will be used.
Resolving
In order to actually display a multisampled canvas, it first has to be downsampled (or ‘resolved’). This is
done automatically once you switch to a different canvas/the backbuffer. Until this step takes place,
your rendering will not be reflected in the canvas’ underlying texture
(and by
extension, in the output of draw
and get_data
).
pub fn stencil_buffer(&mut self, enabled: bool) -> &mut CanvasBuilder
[src]
pub fn stencil_buffer(&mut self, enabled: bool) -> &mut CanvasBuilder
[src]Sets whether the canvas should have a stencil buffer.
Setting this to true
allows you to use stencils while rendering to the canvas, at the cost
of some extra video RAM usage.
Trait Implementations
impl Clone for CanvasBuilder
[src]
impl Clone for CanvasBuilder
[src]fn clone(&self) -> CanvasBuilder
[src]
fn clone(&self) -> CanvasBuilder
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for CanvasBuilder
impl Send for CanvasBuilder
impl Sync for CanvasBuilder
impl Unpin for CanvasBuilder
impl UnwindSafe for CanvasBuilder
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more