Struct RawContext

Source
pub struct RawContext(/* private fields */);
Expand description

Safe thin wrapper for ImGuiContext.

This has common read-only functions.

Implementations§

Source§

impl RawContext

Source

pub fn get(&self) -> &ImGuiContext

Gets a reference to the native wrapper struct.

Source§

impl RawContext

Source

pub fn cast(r: &ImGuiContext) -> &RawContext

Converts a native reference into a wrapper reference.

Source

pub fn cast_mut(r: &mut ImGuiContext) -> &mut RawContext

Converts a native reference into a wrapper reference.

It is safe because if you have a reference to the native reference, you already can change anything.

Source§

impl RawContext

Source

pub unsafe fn current<'a>() -> &'a RawContext

Gets the current ImGui context.

SAFETY: unsafe because the reference lifetime is not well defined.

Source

pub unsafe fn from_ptr<'a>(ptr: *mut ImGuiContext) -> &'a RawContext

Converts a raw DearImGui context pointer into a `&RawContext``.

Source

pub unsafe fn from_ptr_mut<'a>(ptr: *mut ImGuiContext) -> &'a mut RawContext

Converts a raw DearImGui context pointer into a `&mut RawContext``.

Source

pub unsafe fn inner(&mut self) -> &mut ImGuiContext

Gets a reference to the actual DearImGui context struct.

Source

pub fn platform_io(&self) -> &PlatformIo

Returns a safe wrapper for the PlatformIo.

Source

pub unsafe fn platform_io_mut(&mut self) -> &mut PlatformIo

Returns an unsafe mutable wrapper for the PlatformIo.

Source

pub fn io(&self) -> &Io

Returns a safe wrapper for the IO.

Source

pub fn io_mut(&mut self) -> &mut IoMut

Returns a safe mutable wrapper for the IO.

Use io_mut().inner() to get the unsafe wrapper

Source

pub fn style(&self) -> &Style

Returns a reference for the current style definition.

Source

pub fn style_mut(&mut self) -> &mut Style

Gets a mutable reference to the style definition.

Source

pub fn get_main_viewport(&self) -> &Viewport

Gets a reference to the main viewport

Methods from Deref<Target = ImGuiContext>§

Trait Implementations§

Source§

impl Deref for RawContext

Source§

type Target = ImGuiContext

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.