Struct vulkano::display::DisplayMode

pub struct DisplayMode { /* private fields */ }

Represents a mode on a specific display.

A display mode describes a supported display resolution and refresh rate.

Implementations

impl DisplayMode

pub fn new( display: Arc<Display>, create_info: DisplayModeCreateInfo ) -> Result<Arc<Self>, Validated<VulkanError>>

Creates a custom display mode.

pub fn from_handle( display: Arc<Display>, handle: DisplayModeKHR, create_info: DisplayModeCreateInfo ) -> Arc<Self>

Creates a new DisplayMode from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from display.
• create_info must match the info used to create the object, or retrieved from display.

pub fn display(&self) -> &Arc<Display>

Returns the display that this display mode belongs to.

pub fn visible_region(&self) -> [u32; 2]

Returns the extent of the visible region.

pub fn refresh_rate(&self) -> u32

Returns the refresh rate in millihertz (i.e. 60_000 is 60 times per second).

pub fn display_plane_capabilities( &self, plane_index: u32 ) -> Result<DisplayPlaneCapabilities, Validated<VulkanError>>

Returns the capabilities of a display plane, when used with this display mode.

Trait Implementations

impl Debug for DisplayMode

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

Formats the value using the given formatter.

impl Hash for DisplayMode

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

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 InstanceOwned for DisplayMode

fn instance(&self) -> &Arc<Instance>

Returns the instance that owns self.

impl PartialEq for DisplayMode

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

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

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

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

impl VulkanObject for DisplayMode

type Handle = DisplayModeKHR

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for DisplayMode