StreamingRenderer

Struct StreamingRenderer 

Source
pub struct StreamingRenderer<PerFrameDataT: Copy = ()> { /* private fields */ }
Expand description

A renderer optimized for streaming new vertex data to the GPU every frame.

Implementations§

Source§

impl<PerFrameDataT: Copy> StreamingRenderer<PerFrameDataT>

Source

pub fn new( ctx: &VulkanContext, image_format: Format, frames_in_flight: &FramesInFlight, texture_atlas: &TextureAtlas, ) -> Result<Self>

Source

pub fn new_material( &self, ctx: &VulkanContext, vertex_shader: Option<&ShaderModule>, fragment_shader: Option<&ShaderModule>, ) -> Result<Arc<Material>>

Creates a new rendering material. See the documentation for [Material] for details on allowed shader inputs and outputs.

Default vertex and fragment shaders are used automatically if either is omitted.

Source

pub fn default_material(&self) -> &Arc<Material>

Returns the default material for use by meshes without special material requirements.

Source

pub fn prepare_meshes( &mut self, ctx: &VulkanContext, frame: &Frame, meshes: &[&dyn Mesh], ) -> Result<()>

Prepares the meshes for this frame.

This should only be called once per frame, calling it repeatedly will only render whatever meshes were provided last.

Source

pub fn set_frame_constants( &mut self, frame: &Frame, data: PerFrameDataT, ) -> Result<()>

Source

pub fn bind_texture_atlas( &mut self, ctx: &VulkanContext, frame: &Frame, texture_atlas: &TextureAtlas, )

Binds the texture atlas for the frame.

This only needs to be done once a frame, regardless of how many meshes there are as mesh pipelines are required to have compatible pipeline layouts.

Source

pub fn write_draw_commands( &mut self, ctx: &VulkanContext, frame: &Frame, ) -> Result<()>

Emits draw commands for all of the meshes in the current frame.

NOTE: it is incorrect to call this multiple times for the same frame as there is only one internal vertex buffer per frame.

Auto Trait Implementations§

§

impl<PerFrameDataT> Freeze for StreamingRenderer<PerFrameDataT>

§

impl<PerFrameDataT = ()> !RefUnwindSafe for StreamingRenderer<PerFrameDataT>

§

impl<PerFrameDataT> Send for StreamingRenderer<PerFrameDataT>
where PerFrameDataT: Send,

§

impl<PerFrameDataT> Sync for StreamingRenderer<PerFrameDataT>
where PerFrameDataT: Sync,

§

impl<PerFrameDataT> Unpin for StreamingRenderer<PerFrameDataT>
where PerFrameDataT: Unpin,

§

impl<PerFrameDataT = ()> !UnwindSafe for StreamingRenderer<PerFrameDataT>

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<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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

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

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.