Struct rendy::wsi::Surface

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

Rendering target bound to window.

Implementations

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

pub fn new(
    instance: &Instance<B>,
    handle: &impl HasRawWindowHandle
) -> Result<Surface<B>, InitError>

Create surface for the window.

pub unsafe fn new_with(
    instance: &Instance<B>,
    f: impl FnOnce(&<B as Backend>::Instance) -> <B as Backend>::Surface
) -> Surface<B>

Create surface from instance.

Safety

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

pub unsafe fn from_raw(
    surface: <B as Backend>::Surface,
    instance: InstanceId
) -> Surface<B>

Create surface from raw parts.

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

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

Get raw B::Surface reference

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

Get current extent of the surface.

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

Get surface ideal format.

pub unsafe fn supported_formats(
    &self,
    physical_device: &<B as Backend>::PhysicalDevice
) -> Option<Vec<Format>>

Get formats supported by surface

Safety

• physical_device must be created from same Instance as the Surface

pub unsafe fn capabilities(
    &self,
    physical_device: &<B as Backend>::PhysicalDevice
) -> SurfaceCapabilities

Get formats supported by surface

Safety

• physical_device must be created from same Instance as the Surface

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

Cast surface into render target.

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.

Trait Implementations

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

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

Formats the value using the given formatter.