rafx-api 0.0.16

Rendering framework built on an extensible asset pipeline
Documentation
#[cfg(feature = "rafx-dx12")]
use crate::dx12::RafxShaderModuleDx12;
#[cfg(any(
    feature = "rafx-empty",
    not(any(
        feature = "rafx-dx12",
        feature = "rafx-metal",
        feature = "rafx-vulkan",
        feature = "rafx-gles2",
        feature = "rafx-gles3"
    ))
))]
use crate::empty::RafxShaderModuleEmpty;
#[cfg(feature = "rafx-gles2")]
use crate::gles2::RafxShaderModuleGles2;
#[cfg(feature = "rafx-gles3")]
use crate::gles3::RafxShaderModuleGles3;
#[cfg(feature = "rafx-metal")]
use crate::metal::RafxShaderModuleMetal;
#[cfg(feature = "rafx-vulkan")]
use crate::vulkan::RafxShaderModuleVulkan;

/// Rrepresents loaded shader code that can be used to create a pipeline.
///
/// Different APIs require different forms of input. A shader module is created by a "loading"
/// process that is API-specific. This form could be compiled binary or uncompiled shader code,
/// depending on the backend in use.
#[derive(Clone, Debug)]
pub enum RafxShaderModule {
    #[cfg(feature = "rafx-dx12")]
    Dx12(RafxShaderModuleDx12),
    #[cfg(feature = "rafx-vulkan")]
    Vk(RafxShaderModuleVulkan),
    #[cfg(feature = "rafx-metal")]
    Metal(RafxShaderModuleMetal),
    #[cfg(feature = "rafx-gles2")]
    Gles2(RafxShaderModuleGles2),
    #[cfg(feature = "rafx-gles3")]
    Gles3(RafxShaderModuleGles3),
    #[cfg(any(
        feature = "rafx-empty",
        not(any(
            feature = "rafx-dx12",
            feature = "rafx-metal",
            feature = "rafx-vulkan",
            feature = "rafx-gles2",
            feature = "rafx-gles3"
        ))
    ))]
    Empty(RafxShaderModuleEmpty),
}

impl RafxShaderModule {
    /// Get the underlying vulkan API object. This provides access to any internally created
    /// vulkan objects.
    #[cfg(feature = "rafx-dx12")]
    pub fn dx12_shader_module(&self) -> Option<&RafxShaderModuleDx12> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(inner) => Some(inner),
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(_) => None,
        }
    }

    /// Get the underlying vulkan API object. This provides access to any internally created
    /// vulkan objects.
    #[cfg(feature = "rafx-vulkan")]
    pub fn vk_shader_module(&self) -> Option<&RafxShaderModuleVulkan> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(inner) => Some(inner),
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(_) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-metal")]
    pub fn metal_shader_module(&self) -> Option<&RafxShaderModuleMetal> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(inner) => Some(inner),
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(_) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-gles2")]
    pub fn gles2_shader_module(&self) -> Option<&RafxShaderModuleGles2> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(inner) => Some(inner),
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(_) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-gles3")]
    pub fn gles3_shader_module(&self) -> Option<&RafxShaderModuleGles3> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(inner) => Some(inner),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(_) => 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-dx12",
            feature = "rafx-metal",
            feature = "rafx-vulkan",
            feature = "rafx-gles2",
            feature = "rafx-gles3"
        ))
    ))]
    pub fn empty_shader_module(&self) -> Option<&RafxShaderModuleEmpty> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxShaderModule::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxShaderModule::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxShaderModule::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxShaderModule::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxShaderModule::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxShaderModule::Empty(inner) => Some(inner),
        }
    }
}