Struct bevy_retrograde::core::graphics::RenderHookRenderableHandle

pub struct RenderHookRenderableHandle {
    pub identifier: usize,
    pub is_transparent: bool,
    pub depth: i32,
    pub entity: Option<Entity>,
}

Represents a renderable object that can be depth-sorted with other renderables

The depth and is_transparent fields are used to sort the renderable objects before rendering and the identifier field is used by the RenderHook that created the handle to identify the renderable that this handle refers to.

The optional entity can be used to break ties in sort order when depths and transparency are equal

Fields

identifier: usize

Identifier used to by the render hook to uniquely tie this handle to a specific renderable that it knows about

is_transparent: bool

Whether or not this renderable is transparent

depth: i32

The z depth of this renderable in the scene

entity: Option<Entity>

An optional entity to tie to this renderable that will be used to break ties in depth and transparency when sorting

Trait Implementations

impl Clone for RenderHookRenderableHandle

pub fn clone(&self) -> RenderHookRenderableHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RenderHookRenderableHandle

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

Formats the value using the given formatter.

impl Ord for RenderHookRenderableHandle

pub fn cmp(&self, other: &RenderHookRenderableHandle) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RenderHookRenderableHandle> for RenderHookRenderableHandle

pub fn eq(&self, other: &RenderHookRenderableHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &RenderHookRenderableHandle) -> bool

This method tests for !=.

impl PartialOrd<RenderHookRenderableHandle> for RenderHookRenderableHandle

pub fn partial_cmp(
    &self,
    other: &RenderHookRenderableHandle
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RenderHookRenderableHandle

impl Eq for RenderHookRenderableHandle

impl StructuralEq for RenderHookRenderableHandle

impl StructuralPartialEq for RenderHookRenderableHandle