rafx-api 0.0.4

Rendering framework built on an extensible asset pipeline
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

#[cfg(any(
    feature = "rafx-empty",
    not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
))]
use crate::empty::RafxRenderTargetEmpty;
#[cfg(feature = "rafx-metal")]
use crate::metal::RafxRenderTargetMetal;
#[cfg(feature = "rafx-vulkan")]
use crate::vulkan::RafxRenderTargetVulkan;
use crate::{RafxRenderTargetDef, RafxTexture};

/// 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)
#[derive(Clone, Debug)]
pub enum RafxRenderTarget {
    #[cfg(feature = "rafx-vulkan")]
    Vk(RafxRenderTargetVulkan),
    #[cfg(feature = "rafx-metal")]
    Metal(RafxRenderTargetMetal),
    #[cfg(any(
        feature = "rafx-empty",
        not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
    ))]
    Empty(RafxRenderTargetEmpty),
}

impl RafxRenderTarget {
    /// Return the metadata used to create the render target
    pub fn render_target_def(&self) -> &RafxRenderTargetDef {
        match self {
            #[cfg(feature = "rafx-vulkan")]
            RafxRenderTarget::Vk(inner) => inner.render_target_def(),
            #[cfg(feature = "rafx-metal")]
            RafxRenderTarget::Metal(inner) => inner.render_target_def(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
            ))]
            RafxRenderTarget::Empty(inner) => inner.render_target_def(),
        }
    }

    /// Returns this render target as a texture. (All render targets can be used as textures.)
    pub fn texture(&self) -> &RafxTexture {
        match self {
            #[cfg(feature = "rafx-vulkan")]
            RafxRenderTarget::Vk(inner) => inner.texture(),
            #[cfg(feature = "rafx-metal")]
            RafxRenderTarget::Metal(inner) => inner.texture(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
            ))]
            RafxRenderTarget::Empty(inner) => inner.texture(),
        }
    }

    /// Get the underlying vulkan API object. This provides access to any internally created
    /// vulkan objects.
    #[cfg(feature = "rafx-vulkan")]
    pub fn vk_render_target(&self) -> Option<&RafxRenderTargetVulkan> {
        match self {
            #[cfg(feature = "rafx-vulkan")]
            RafxRenderTarget::Vk(inner) => Some(inner),
            #[cfg(feature = "rafx-metal")]
            RafxRenderTarget::Metal(_inner) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
            ))]
            RafxRenderTarget::Empty(_inner) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-metal")]
    pub fn metal_render_target(&self) -> Option<&RafxRenderTargetMetal> {
        match self {
            #[cfg(feature = "rafx-vulkan")]
            RafxRenderTarget::Vk(_inner) => None,
            #[cfg(feature = "rafx-metal")]
            RafxRenderTarget::Metal(inner) => Some(inner),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
            ))]
            RafxRenderTarget::Empty(_inner) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(any(
        feature = "rafx-empty",
        not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
    ))]
    pub fn empty_render_target(&self) -> Option<&RafxRenderTargetEmpty> {
        match self {
            #[cfg(feature = "rafx-vulkan")]
            RafxRenderTarget::Vk(_inner) => None,
            #[cfg(feature = "rafx-metal")]
            RafxRenderTarget::Metal(_inner) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(feature = "rafx-metal", feature = "rafx-vulkan"))
            ))]
            RafxRenderTarget::Empty(inner) => Some(inner),
        }
    }
}