Struct bevy::render::renderer::RenderContext

pub struct RenderContext<'w> { /* private fields */ }

The context with all information required to interact with the GPU.

The RenderDevice is used to create render resources and the the CommandEncoder is used to record a series of GPU operations.

Implementations

impl<'w> RenderContext<'w>

pub fn new( render_device: RenderDevice, adapter_info: AdapterInfo ) -> RenderContext<'w>

Creates a new RenderContext from a RenderDevice.

pub fn render_device(&self) -> &RenderDevice

Gets the underlying RenderDevice.

pub fn command_encoder(&mut self) -> &mut CommandEncoder

Gets the current CommandEncoder.

pub fn begin_tracked_render_pass<'a>( &'a mut self, descriptor: RenderPassDescriptor<'a, '_> ) -> TrackedRenderPass<'a>

Creates a new TrackedRenderPass for the context, configured using the provided descriptor.

pub fn add_command_buffer(&mut self, command_buffer: CommandBuffer)

Append a CommandBuffer to the command buffer queue.

If present, this will flush the currently unflushed CommandEncoder into a CommandBuffer into the queue before appending the provided buffer.

pub fn add_command_buffer_generation_task( &mut self, task: impl FnOnce(RenderDevice) -> CommandBuffer + Send + 'w )

Append a function that will generate a CommandBuffer to the command buffer queue, to be ran later.

If present, this will flush the currently unflushed CommandEncoder into a CommandBuffer into the queue before appending the provided buffer.

pub fn finish(self) -> Vec<CommandBuffer>

Finalizes and returns the queue of CommandBuffers.

This function will wait until all command buffer generation tasks are complete by running them in parallel (where supported).