pub enum DrawTarget {
    Default {
        rect: FramebufferIntRect,
        total_size: FramebufferIntSize,
        surface_origin_is_top_left: bool,
    },
    Texture {
        dimensions: DeviceIntSize,
        with_depth: bool,
        fbo_id: FBOId,
        id: GLuint,
        target: GLuint,
    },
    External {
        fbo: FBOId,
        size: FramebufferIntSize,
    },
    NativeSurface {
        offset: DeviceIntPoint,
        external_fbo_id: u32,
        dimensions: DeviceIntSize,
    },
}
Expand description

Contains the parameters necessary to bind a draw target.

Variants§

§

Default

Fields

§rect: FramebufferIntRect

Target rectangle to draw.

§total_size: FramebufferIntSize

Total size of the target.

§surface_origin_is_top_left: bool

Use the device’s default draw target, with the provided dimensions, which are used to set the viewport.

§

Texture

Fields

§dimensions: DeviceIntSize

Size of the texture in pixels

§with_depth: bool

Whether to draw with the texture’s associated depth target

§fbo_id: FBOId

FBO that corresponds to the selected layer / depth mode

§id: GLuint

Native GL texture ID

§target: GLuint

Native GL texture target

Use the provided texture.

§

External

Use an FBO attached to an external texture.

§

NativeSurface

Fields

§external_fbo_id: u32
§dimensions: DeviceIntSize

An OS compositor surface

Implementations§

source§

impl DrawTarget

source

pub fn new_default( size: DeviceIntSize, surface_origin_is_top_left: bool ) -> Self

source

pub fn is_default(&self) -> bool

Returns true if this draw target corresponds to the default framebuffer.

source

pub fn from_texture(texture: &Texture, with_depth: bool) -> Self

source

pub fn dimensions(&self) -> DeviceIntSize

Returns the dimensions of this draw-target.

source

pub fn offset(&self) -> DeviceIntPoint

source

pub fn to_framebuffer_rect( &self, device_rect: DeviceIntRect ) -> FramebufferIntRect

source

pub fn surface_origin_is_top_left(&self) -> bool

source

pub fn build_scissor_rect( &self, scissor_rect: Option<DeviceIntRect> ) -> FramebufferIntRect

Given a scissor rect, convert it to the right coordinate space depending on the draw target kind. If no scissor rect was supplied, returns a scissor rect that encloses the entire render target.

Trait Implementations§

source§

impl Clone for DrawTarget

source§

fn clone(&self) -> DrawTarget

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DrawTarget

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<DrawTarget> for ReadTarget

source§

fn from(t: DrawTarget) -> Self

Converts to this type from the input type.
source§

impl Copy for DrawTarget

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.