Skip to main content

EngineBitfield

Trait EngineBitfield 

Source
pub trait EngineBitfield: Copy + 'static {
    // Required methods
    fn try_from_ord(ord: u64) -> Option<Self>;
    fn ord(self) -> u64;
    fn all_constants() -> &'static [EnumConstant<Self>];

    // Provided methods
    fn from_ord(ord: u64) -> Self { ... }
    fn is_set(self, flag: Self) -> bool { ... }
}
Expand description

Auto-implemented for all engine-provided bitfields.

Required Methods§

Source

fn try_from_ord(ord: u64) -> Option<Self>

Source

fn ord(self) -> u64

Ordinal value of the bit flag, as specified in Godot.

Source

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

Returns metadata for all bitfield constants.

This includes all constants as they appear in the bitfield definition.

Enables introspection of available constants:

use godot::global::KeyModifierMask;
use godot::obj::EngineBitfield;

for constant in KeyModifierMask::all_constants() {
    println!("* KeyModifierMask.{} (original {}) has ordinal value {}.",
        constant.rust_name(),
        constant.godot_name(),
        constant.value().ord()
    );
}

Provided Methods§

Source

fn from_ord(ord: u64) -> Self

Source

fn is_set(self, flag: Self) -> bool

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl EngineBitfield for SizeFlags

Source§

impl EngineBitfield for AxisFlag

Source§

impl EngineBitfield for godot::classes::copy_transform_modifier_3d::TransformFlag

Source§

impl EngineBitfield for DockLayout

Source§

impl EngineBitfield for DebugFlags

Source§

impl EngineBitfield for ModeFlags

Source§

impl EngineBitfield for UnixPermissionFlags

Source§

impl EngineBitfield for godot::classes::gpu_particles_2d::EmitFlags

Source§

impl EngineBitfield for godot::classes::gpu_particles_3d::EmitFlags

Source§

impl EngineBitfield for LoaderFlags

Source§

impl EngineBitfield for godot::classes::mesh::ArrayFormat

Source§

impl EngineBitfield for godot::classes::navigation_path_query_parameters_2d::PathMetadataFlags

Source§

impl EngineBitfield for godot::classes::navigation_path_query_parameters_3d::PathMetadataFlags

Source§

impl EngineBitfield for DuplicateFlags

Source§

impl EngineBitfield for ProcessThreadMessages

Source§

impl EngineBitfield for ConnectFlags

Source§

impl EngineBitfield for godot::classes::open_xr_interface::HandJointFlags

Source§

impl EngineBitfield for BarrierMask

Source§

impl EngineBitfield for BufferCreationBits

Source§

impl EngineBitfield for DrawFlags

Source§

impl EngineBitfield for PipelineDynamicStateFlags

Source§

impl EngineBitfield for StorageBufferUsage

Source§

impl EngineBitfield for TextureUsageBits

Source§

impl EngineBitfield for godot::classes::rendering_server::ArrayFormat

Source§

impl EngineBitfield for SaverFlags

Source§

impl EngineBitfield for godot::classes::retarget_modifier_3d::TransformFlag

Source§

impl EngineBitfield for ImageUpdateMask

Source§

impl EngineBitfield for GroupCallFlags

Source§

impl EngineBitfield for SearchFlags

Source§

impl EngineBitfield for FontStyle

Source§

impl EngineBitfield for GraphemeFlag

Source§

impl EngineBitfield for JustificationFlag

Source§

impl EngineBitfield for LineBreakFlag

Source§

impl EngineBitfield for TextOverrunFlag

Source§

impl EngineBitfield for BodyUpdate

Source§

impl EngineBitfield for BodyFlags

Source§

impl EngineBitfield for JointFlags

Source§

impl EngineBitfield for godot::classes::xr_hand_tracker::HandJointFlags

Source§

impl EngineBitfield for KeyModifierMask

Source§

impl EngineBitfield for MouseButtonMask

Source§

impl EngineBitfield for MethodFlags

Source§

impl EngineBitfield for PropertyUsageFlags