Skip to main content

Gpu

Struct Gpu 

Source
pub struct Gpu {
    pub device: Device,
    pub queue: Queue,
}
Expand description

Handle to a GPU device

Fields§

§device: Device

GPU device

§queue: Queue

GPU queue

Implementations§

Source§

impl Gpu

Source

pub async fn init() -> Result<Gpu, InitError>

Returns a Gpu object with customized settings

Non-default settings are as follows:

This is a helper function for simplicity; more sophisticated systems will likely construct the adapter, device, and queue themselves.

Source

pub fn read_buffer_for<T>(&self, buf: &FlexBuffer<T>) -> ReadBuffer<T>
where T: BufferTag,

Returns a readable buffer for the given buffer

See copy and map for how to use the resulting read buffer.

Source

pub fn read_buffer<T>(&self, name: &str) -> ReadBuffer<T>
where T: BufferTag, T::S: TryFrom<u32>,

Builds a new readable buffer

The buffer has an arbitrary starting size and will be resized when used in copy.

If the target buffer is known, use read_buffer_for to avoid this reallocation.

Source

pub fn read_vec<T: BufferTag>(&self, buf: &FlexBuffer<T>) -> Vec<T::T>
where T::T: FromBytes + Immutable + Clone + Copy,

Helper function to read from a buffer to a Vec

Under the hood, this function simply calls read_buffer_for, copy, map, and to_vec.

Note that this function allocates a GPU buffer; if the same source buffer is being read repeatedly, it’s recommended to build the read buffer once and then call copy, map, to_vec repeatedly.

Source

pub fn copy<A>(&self, src: &FlexBuffer<A>, dst: &mut ReadBuffer<A>)
where A: BufferTag,

Copies from a GPU-resident buffer to a host-mappable buffer

The host-mappable destination buffer is resized to fit the data.

Source

pub fn encode_copy<A>( &self, src: &FlexBuffer<A>, dst: &mut ReadBuffer<A>, encoder: &mut CommandEncoder, )
where A: BufferTag,

Low-level command to submit a buffer copy to a command encoder

See copy for details

Source

pub fn map<'a, T>(&self, image: &'a mut ReadBuffer<T>) -> MappedBuffer<'a, T>
where T: BufferTag, T::T: Immutable + FromBytes + Copy,

Blocking function to build a new mapped buffer

Source

pub async fn map_async<'a, T>( &self, data: &'a mut ReadBuffer<T>, ) -> MappedBuffer<'a, T>
where T: BufferTag, T::T: Immutable + FromBytes + Copy,

Async function to build a new mapped buffer

This can be called on either native or web platforms. On native platforms, the single await is trivial (guaranteed to always be ready); on the web, the mapping sends us back to the event loop until it’s ready.

Source

pub fn map_image<'a, T>( &self, data: &'a mut ReadBuffer<T>, ) -> MappedImage<'a, T>
where T: BufferTag, T::T: Immutable + FromBytes + Copy, T::S: RenderSize,

Blocking function to build a new mapped image

Source

pub async fn map_image_async<'a, T>( &self, data: &'a mut ReadBuffer<T>, ) -> MappedImage<'a, T>
where T: BufferTag, T::T: Immutable + FromBytes + Copy, T::S: RenderSize,

Async function to build a new mapped image

This can be called on either native or web platforms. On native platforms, the single await is trivial (guaranteed to always be ready); on the web, the mapping sends us back to the event loop until it’s ready.

Trait Implementations§

Source§

impl Clone for Gpu

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Gpu

§

impl !UnwindSafe for Gpu

§

impl Freeze for Gpu

§

impl Send for Gpu

§

impl Sync for Gpu

§

impl Unpin for Gpu

§

impl UnsafeUnpin for Gpu

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,