Struct BgMode 

pub struct BgMode { /* private fields */ }

Godot enum name: BGMode.

Implementations

impl BgMode

pub const CLEAR_COLOR: BgMode

Godot enumerator name: BG_CLEAR_COLOR

pub const COLOR: BgMode

Godot enumerator name: BG_COLOR

pub const SKY: BgMode

Godot enumerator name: BG_SKY

pub const CANVAS: BgMode

Godot enumerator name: BG_CANVAS

pub const KEEP: BgMode

Godot enumerator name: BG_KEEP

pub const CAMERA_FEED: BgMode

Godot enumerator name: BG_CAMERA_FEED

pub const MAX: BgMode

Godot enumerator name: BG_MAX

Trait Implementations

impl Clone for BgMode

fn clone(&self) -> BgMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BgMode

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

Formats the value using the given formatter.

impl EngineEnum for BgMode

fn try_from_ord(ord: i32) -> Option<BgMode>

fn ord(self) -> i32

Ordinal value of the enumerator, as specified in Godot. This is not necessarily unique.

fn as_str(&self) -> &'static str

The name of the enumerator, as it appears in Rust.

fn values() -> &'static [BgMode]

Returns a slice of distinct enum values.

fn all_constants() -> &'static [EnumConstant<BgMode>]

Returns metadata for all enum constants.

fn from_ord(ord: i32) -> Self

impl Export for BgMode

fn export_hint() -> PropertyHintInfo

The export info to use for an exported field of this type, if no other export info is specified.

impl FromGodot for BgMode

fn try_from_godot( via: <BgMode as GodotConvert>::Via, ) -> Result<BgMode, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl GodotConvert for BgMode

type Via = i32

The type through which Self is represented in Godot.

impl Hash for BgMode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IndexEnum for BgMode

const ENUMERATOR_COUNT: usize = 6usize

Number of distinct enumerators in the enum.

fn to_index(self) -> usize

Converts the enumerator to usize, which can be used as an array index.

impl PartialEq for BgMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToGodot for BgMode

type Pass = ByValue

Whether arguments of this type are passed by value or by reference.

fn to_godot(&self) -> <BgMode as GodotConvert>::Via

Converts this type to Godot representation, optimizing for zero-copy when possible.

fn to_godot_owned(&self) -> Self::Via

where Self::Via: Clone,

Converts this type to owned Godot representation.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Var for BgMode

type PubType = BgMode

Type used in generated Rust getters/setters for #[var(pub)].

fn var_get(field: &BgMode) -> <BgMode as GodotConvert>::Via

Get property value. Called when reading a property from Godot.

fn var_set(field: &mut BgMode, value: <BgMode as GodotConvert>::Via)

Set property value. Called when writing a property from Godot.

fn var_pub_get(field: &BgMode) -> <BgMode as Var>::PubType

Get property value in a Rust auto-generated getter, for fields annotated with #[var(pub)].

fn var_pub_set(field: &mut BgMode, value: <BgMode as Var>::PubType)

Set property value in a Rust auto-generated setter, for fields annotated with #[var(pub)].

fn var_hint() -> PropertyHintInfo

Specific property hints. Only override if they deviate from GodotType::property_info, e.g. for enums/newtypes.

impl Copy for BgMode

impl Eq for BgMode

impl StructuralPartialEq for BgMode