Enum rafx_api::RafxRenderTarget

pub enum RafxRenderTarget {
    Vk(RafxRenderTargetVulkan),
}

Render targets are writable textures that the GPU can render to.

The general flow is to bind a render target and pipeline to a command buffer and draw primitives.

Render targets can generally be used in APIs that accept textures. (However they may require being transitioned to a state appropriate to how they will be used.)

Render targets are cloneable because they are sometimes owned by the swapchain. Using a render target provided by a swapchain after the swapchain has been destroyed will result in undefined behavior. However, a render target created by an application can be used as long as it is not dropped and as long as the GPU is using it.

Render targets not owned by a swapchain must not be dropped if they are in use by the GPU. (Individual clones may be dropped, but one of the instances must remain)

Variants

Vk(RafxRenderTargetVulkan)

Implementations

impl RafxRenderTarget

pub fn render_target_def(&self) -> &RafxRenderTargetDef

Return the metadata used to create the render target

pub fn texture(&self) -> &RafxTexture

Returns this render target as a texture. (All render targets can be used as textures.)

pub fn vk_render_target(&self) -> Option<&RafxRenderTargetVulkan>

Get the underlying vulkan API object. This provides access to any internally created vulkan objects.

Trait Implementations

impl Clone for RafxRenderTarget

pub fn clone(&self) -> RafxRenderTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RafxRenderTarget

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<RafxRenderTarget> for RafxImage

pub fn from(render_target: RafxRenderTarget) -> Self

Performs the conversion.

impl Into<RafxRenderTarget> for RafxRenderTargetVulkan

pub fn into(self) -> RafxRenderTarget

Performs the conversion.