Struct Viewport 

pub struct Viewport { /* private fields */ }

Viewport structure for multi-viewport support

This is a transparent wrapper around ImGuiViewport that provides safe access to viewport functionality.

Implementations

impl Viewport

pub fn main() -> &'static Self

Returns a reference to the main Dear ImGui viewport (safe wrapper)

This is the same viewport used by Ui::dockspace_over_main_viewport(). Requires an active ImGui context.

pub unsafe fn from_raw_mut(raw: *mut ImGuiViewport) -> &'static mut Self

Get a mutable reference to the viewport from a raw pointer

Safety

The caller must ensure that the pointer is valid and points to a valid ImGuiViewport structure, and that no other references exist.

pub fn as_raw(&self) -> *const ImGuiViewport

Get the raw pointer to the underlying ImGuiViewport

pub fn as_raw_mut(&mut self) -> *mut ImGuiViewport

Get the raw mutable pointer to the underlying ImGuiViewport

pub fn id(&self) -> ImGuiID

Get the viewport ID

pub fn set_pos(&mut self, pos: [f32; 2])

Set the viewport position

pub fn pos(&self) -> [f32; 2]

Get the viewport position

pub fn set_size(&mut self, size: [f32; 2])

Set the viewport size

pub fn size(&self) -> [f32; 2]

Get the viewport size

pub fn work_pos(&self) -> [f32; 2]

Get the viewport work position (excluding menu bars, task bars, etc.)

pub fn work_size(&self) -> [f32; 2]

Get the viewport work size (excluding menu bars, task bars, etc.)

pub fn is_main(&self) -> bool

pub fn is_platform_window(&self) -> bool

pub fn is_platform_monitor(&self) -> bool

pub fn is_owned_by_app(&self) -> bool

pub fn platform_user_data(&self) -> *mut c_void

Get the platform user data

pub fn set_platform_user_data(&mut self, data: *mut c_void)

Set the platform user data

pub fn renderer_user_data(&self) -> *mut c_void

Get the renderer user data

pub fn set_renderer_user_data(&mut self, data: *mut c_void)

Set the renderer user data

pub fn platform_handle(&self) -> *mut c_void

Get the platform handle

pub fn set_platform_handle(&mut self, handle: *mut c_void)

Set the platform handle

pub fn platform_window_created(&self) -> bool

Check if the platform window was created

pub fn set_platform_window_created(&mut self, created: bool)

Set whether the platform window was created

pub fn platform_request_move(&self) -> bool

Check if the platform requested move

pub fn set_platform_request_move(&mut self, request: bool)

Set whether the platform requested move

pub fn platform_request_resize(&self) -> bool

Check if the platform requested resize

pub fn set_platform_request_resize(&mut self, request: bool)

Set whether the platform requested resize

pub fn platform_request_close(&self) -> bool

Check if the platform requested close

pub fn set_platform_request_close(&mut self, request: bool)

Set whether the platform requested close

pub fn flags(&self) -> ImGuiViewportFlags

Get the viewport flags

pub fn set_flags(&mut self, flags: ImGuiViewportFlags)

Set the viewport flags