[−][src]Struct amethyst_rendy::rendy::resource::Image

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

Generic image resource wrapper.

Parameters

B - raw image type.

Methods

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

`pub unsafe fn create<impl MemoryUsage>( device: &Device, heaps: &mut Heaps, info: ImageInfo, memory_usage: impl MemoryUsage ) -> Result<Image, Error> where impl MemoryUsage: MemoryUsage,` [src]

Create image.

Safety

In order to guarantee that Heap::allocate will return memory range owned by this Device, this Heaps instance must always be used with this Device instance.

Otherwise usage of hal methods must be always valid.

`pub unsafe fn create_from_swapchain( device: DeviceId, info: ImageInfo, raw: ::Image ) -> Image`[src]

Create image handler for swapchain image.

`pub unsafe fn dispose(self, device: &Device, heaps: &mut Heaps)`[src]

Destroy image resource.

`pub unsafe fn dispose_swapchain_image(self, device: DeviceId)`[src]

Drop image wrapper for swapchain image.

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

Get reference for raw image resource.

`pub unsafe fn raw_mut(&mut self) -> &mut ::Image`[src]

Get mutable reference for raw image resource.

`pub fn block(&self) -> Option<&MemoryBlock>`[src]

Get reference to memory block occupied by image.

`pub unsafe fn block_mut(&mut self) -> Option<&mut MemoryBlock>`[src]

Get mutable reference to memory block occupied by image.

`pub fn info(&self) -> &ImageInfo`[src]

Get image info.

`pub fn kind(&self) -> Kind`[src]

Get Kind of the image.

`pub fn format(&self) -> Format`[src]

Get Format of the image.

`pub fn levels(&self) -> u8`[src]

Get levels count of the image.

`pub fn layers(&self) -> u16`[src]

Get layers count of the image.

`impl Image where B: Backend,`

`pub fn device_id(&self) -> DeviceId`

Get owned id.

`pub fn assert_device_owner(&self, device: &Device)`

Assert specified device is owner.

`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 Image where B: Debug + Backend, ::Image: Debug,` [src]

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

Auto Trait Implementations

`impl Unpin for Image where ::Image: Unpin, ::Memory: Unpin,`

`impl Sync for Image where ::Image: Sync,`

`impl Send for Image where ::Image: Send,`

`impl UnwindSafe for Image where ::Image: UnwindSafe, ::Memory: RefUnwindSafe + UnwindSafe,`

`impl RefUnwindSafe for Image where ::Image: RefUnwindSafe, ::Memory: 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::resource::Image

Parameters

Methods

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

pub unsafe fn create<impl MemoryUsage>( device: &Device<B>, heaps: &mut Heaps<B>, info: ImageInfo, memory_usage: impl MemoryUsage) -> Result<Image<B>, Error> where impl MemoryUsage: MemoryUsage, [src]

Safety

pub unsafe fn create_from_swapchain( device: DeviceId, info: ImageInfo, raw: <B as Backend>::Image) -> Image<B>[src]

pub unsafe fn dispose(self, device: &Device<B>, heaps: &mut Heaps<B>)[src]

pub unsafe fn dispose_swapchain_image(self, device: DeviceId)[src]

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

pub unsafe fn raw_mut(&mut self) -> &mut <B as Backend>::Image[src]

pub fn block(&self) -> Option<&MemoryBlock<B>>[src]

pub unsafe fn block_mut(&mut self) -> Option<&mut MemoryBlock<B>>[src]

pub fn info(&self) -> &ImageInfo[src]

pub fn kind(&self) -> Kind[src]

pub fn format(&self) -> Format[src]

pub fn levels(&self) -> u8[src]

pub fn layers(&self) -> u16[src]

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

pub fn device_id(&self) -> DeviceId

pub fn assert_device_owner(&self, device: &Device<B>)

pub fn instance_id(&self) -> InstanceId

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

Trait Implementations

impl<B> Debug for Image<B> where B: Debug + Backend, <B as Backend>::Image: Debug, [src]

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

Auto Trait Implementations

impl<B> Unpin for Image<B> where <B as Backend>::Image: Unpin, <B as Backend>::Memory: Unpin,

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

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

impl<B> UnwindSafe for Image<B> where <B as Backend>::Image: UnwindSafe, <B as Backend>::Memory: RefUnwindSafe + UnwindSafe,

impl<B> RefUnwindSafe for Image<B> where <B as Backend>::Image: RefUnwindSafe, <B as Backend>::Memory: 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> Image<B> where B: Backend,` [src]

`pub unsafe fn create<impl MemoryUsage>( device: &Device<B>, heaps: &mut Heaps<B>, info: ImageInfo, memory_usage: impl MemoryUsage ) -> Result<Image<B>, Error> where impl MemoryUsage: MemoryUsage,` [src]

`pub unsafe fn create_from_swapchain( device: DeviceId, info: ImageInfo, raw: <B as Backend>::Image ) -> Image<B>`[src]

`pub unsafe fn dispose(self, device: &Device<B>, heaps: &mut Heaps<B>)`[src]

`pub unsafe fn dispose_swapchain_image(self, device: DeviceId)`[src]

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

`pub unsafe fn raw_mut(&mut self) -> &mut <B as Backend>::Image`[src]

`pub fn block(&self) -> Option<&MemoryBlock<B>>`[src]

`pub unsafe fn block_mut(&mut self) -> Option<&mut MemoryBlock<B>>`[src]

`pub fn info(&self) -> &ImageInfo`[src]

`pub fn kind(&self) -> Kind`[src]

`pub fn format(&self) -> Format`[src]

`pub fn levels(&self) -> u8`[src]

`pub fn layers(&self) -> u16`[src]

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

`pub fn device_id(&self) -> DeviceId`

`pub fn assert_device_owner(&self, device: &Device<B>)`

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

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

`impl<B> Debug for Image<B> where B: Debug + Backend, <B as Backend>::Image: Debug,` [src]

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

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

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

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

`impl<B> UnwindSafe for Image<B> where <B as Backend>::Image: UnwindSafe, <B as Backend>::Memory: RefUnwindSafe + UnwindSafe,`

`impl<B> RefUnwindSafe for Image<B> where <B as Backend>::Image: RefUnwindSafe, <B as Backend>::Memory: 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]