Struct rendy_wsi::Surface

pub struct Surface<B: Backend> { /* fields omitted */ }

Rendering target bound to window.

Methods

impl<B> Surface<B> where
    B: Backend, 

pub fn instance_id(&self) -> InstanceId

Get owned id.

pub fn assert_instance_owner(&self, instance: &Instance<B>)

Assert specified instance is owner.

impl<B> Surface<B> where
    B: Backend, 

pub fn new(instance: &Instance<B>, window: &Window) -> Self

Create surface for the window.

pub unsafe fn create<T>(
    instance: &Instance<B>,
    f: impl FnOnce(&T) -> B::Surface
) -> Self where
    T: Instance<Backend = B>, 

Create surface from instance.

Safety

Closure must return surface object created from raw instance provided as closure argument.

impl<B> Surface<B> where
    B: Backend, 

pub fn raw(&self) -> &B::Surface

Get raw B::Surface reference

pub unsafe fn extent(
    &self,
    physical_device: &B::PhysicalDevice
) -> Option<Extent2D>

Get current extent of the surface.

pub unsafe fn format(&self, physical_device: &B::PhysicalDevice) -> Format

Get surface ideal format.

pub unsafe fn compatibility(
    &self,
    physical_device: &B::PhysicalDevice
) -> (SurfaceCapabilities, Option<Vec<Format>>, Vec<PresentMode>)

Get surface compatibility

Safety

• physical_device must be created from same Instance as the Surface

pub unsafe fn into_target(
    self,
    physical_device: &B::PhysicalDevice,
    device: &Device<B>,
    suggest_extent: Extent2D,
    image_count: u32,
    present_mode: PresentMode,
    usage: Usage
) -> Result<Target<B>, Error>

Cast surface into render target.

Trait Implementations

impl<B> Debug for Surface<B> where
    B: Backend, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.