[−][src]Struct amethyst_rendy::rendy::wsi::Surface

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

Rendering target bound to window.

Methods

`impl Surface where B: Backend,` [src]

`pub fn new(instance: &Instance, window: &Window) -> Surface`[src]

Create surface for the window.

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

Create surface from instance.

Safety

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

`impl Surface where B: Backend,` [src]

`pub fn raw(&self) -> &::Surface`[src]

Get raw B::Surface reference

`pub unsafe fn extent( &self, physical_device: &::PhysicalDevice ) -> Option<Extent2D>`[src]

Get current extent of the surface.

`pub unsafe fn format( &self, physical_device: &::PhysicalDevice ) -> Format`[src]

Get surface ideal format.

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

Get surface compatibility

Safety

physical_device must be created from same Instance as the Surface

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

Cast surface into render target.

`impl Surface where B: Backend,`

`pub fn instance_id(&self) -> InstanceId`

Get owned id.

`pub fn assert_instance_owner(&self, instance: &Instance)`

Assert specified instance is owner.

Trait Implementations

`impl Debug for Surface where B: Backend,` [src]

`fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>`[src]

Auto Trait Implementations

`impl Unpin for Surface where ::Surface: Unpin,`

`impl Sync for Surface where ::Surface: Sync,`

`impl Send for Surface where ::Surface: Send,`

`impl UnwindSafe for Surface where ::Surface: UnwindSafe,`

`impl RefUnwindSafe for Surface where ::Surface: RefUnwindSafe,`

Blanket Implementations

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

Convert the source color to the destination color using the bradford method by default Read more

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

Sets value as a parameter of self.

`impl<T> Supports<T> for T`[src]

`impl<T> Erased for T`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

[−][src]Struct amethyst_rendy::rendy::wsi::Surface

Methods

impl<B> Surface<B> where B: Backend, [src]

pub fn new(instance: &Instance<B>, window: &Window) -> Surface<B>[src]

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

Safety

impl<B> Surface<B> where B: Backend, [src]

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

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

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

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

Safety

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>, Error>[src]

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

pub fn instance_id(&self) -> InstanceId

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

Trait Implementations

impl<B> Debug for Surface<B> where B: Backend, [src]

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>[src]

Auto Trait Implementations

impl<B> Unpin for Surface<B> where <B as Backend>::Surface: Unpin,

impl<B> Sync for Surface<B> where <B as Backend>::Surface: Sync,

impl<B> Send for Surface<B> where <B as Backend>::Surface: Send,

impl<B> UnwindSafe for Surface<B> where <B as Backend>::Surface: UnwindSafe,

impl<B> RefUnwindSafe for Surface<B> where <B as Backend>::Surface: RefUnwindSafe,

Blanket Implementations

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

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

fn type_id(&self) -> TypeId[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float, [src]

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>, [src]

fn adapt_into(self) -> D[src]

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>, [src]

impl<T> Supports<T> for T[src]

impl<T> Erased for T[src]

impl<T> Same<T> for T[src]

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

fn to_subset(&self) -> Option<SS>[src]

fn is_in_subset(&self) -> bool[src]

unsafe fn to_subset_unchecked(&self) -> SS[src]

fn from_subset(element: &SS) -> SP[src]

impl<T> Resource for T where T: Any + Send + Sync, [src]

impl<T> Any for T where T: Any, [src]

fn get_type_id(&self) -> TypeId[src]

impl<T> Event for T where T: Send + Sync + 'static, [src]

`impl<B> Surface<B> where B: Backend,` [src]

`pub fn new(instance: &Instance<B>, window: &Window) -> Surface<B>`[src]

`pub unsafe fn create<T, impl FnOnce(&T) -> B::Surface>( instance: &Instance<B>, f: impl FnOnce(&T) -> B::Surface ) -> Surface<B> where T: Instance<Backend = B>, impl FnOnce(&T) -> B::Surface: FnOnce(&T) -> <B as Backend>::Surface,` [src]

`impl<B> Surface<B> where B: Backend,` [src]

`pub fn raw(&self) -> &<B as Backend>::Surface`[src]

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

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

`pub unsafe fn compatibility( &self, physical_device: &<B as Backend>::PhysicalDevice ) -> (SurfaceCapabilities, Option<Vec<Format>>, Vec<PresentMode>)`[src]

`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>, Error>`[src]

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

`pub fn instance_id(&self) -> InstanceId`

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

`impl<B> Debug for Surface<B> where B: Backend,` [src]

`fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>`[src]

`impl<B> Unpin for Surface<B> where <B as Backend>::Surface: Unpin,`

`impl<B> Sync for Surface<B> where <B as Backend>::Surface: Sync,`

`impl<B> Send for Surface<B> where <B as Backend>::Surface: Send,`

`impl<B> UnwindSafe for Surface<B> where <B as Backend>::Surface: UnwindSafe,`

`impl<B> RefUnwindSafe for Surface<B> where <B as Backend>::Surface: RefUnwindSafe,`

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

`impl<T> Supports<T> for T`[src]

`impl<T> Erased for T`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`fn to_subset(&self) -> Option<SS>`[src]

`fn is_in_subset(&self) -> bool`[src]

`unsafe fn to_subset_unchecked(&self) -> SS`[src]

`fn from_subset(element: &SS) -> SP`[src]

`impl<T> Resource for T where T: Any + Send + Sync,` [src]

`impl<T> Any for T where T: Any,` [src]

`fn get_type_id(&self) -> TypeId`[src]

`impl<T> Event for T where T: Send + Sync + 'static,` [src]