Struct VulkanShader 

pub struct VulkanShader {
    pub device: Arc<VulkanDevice>,
    /* private fields */
}

The wrapper for VkShaderModule

Fields

device: Arc<VulkanDevice>

The associated device

Implementations

impl VulkanShader

pub fn new( device: Arc<VulkanDevice>, shader_code: &[u32], entry_point: &str, ) -> Result<Self, VulkanError>

Create the VulkanShader from the shader code, it should be aligned to 32-bits

pub fn new_from_file( device: Arc<VulkanDevice>, shader_file: &PathBuf, entry_point: &str, ) -> Result<Self, VulkanError>

Create the VulkanShader from file

pub fn compile( device: Arc<VulkanDevice>, code: ShaderSource<'_>, is_hlsl: bool, filename: &str, entry_point: &str, level: OptimizationLevel, warning_as_error: bool, ) -> Result<Vec<u32>, VulkanError>

Compile shader code to binary

• level: You could use one of these: OptimizationLevel::Zero, OptimizationLevel::Size, and OptimizationLevel::Performance

pub fn load_cache_or_compile( device: Arc<VulkanDevice>, code: ShaderSourcePath, is_hlsl: bool, entry_point: &str, level: OptimizationLevel, warning_as_error: bool, ) -> Result<Vec<u32>, VulkanError>

Compile shader code to binary, or load from the cache.

• level: You could use one of these: OptimizationLevel::Zero, OptimizationLevel::Size, and OptimizationLevel::Performance

Overwrite

• The cache file path is the source file path modified by replacing the file extension with .spv.
• The existing file will be REPLACED with the newly compiled binary data if the source file is newer than the cache file.

pub fn new_from_source( device: Arc<VulkanDevice>, code: ShaderSource<'_>, is_hlsl: bool, filename: &str, entry_point: &str, level: OptimizationLevel, warning_as_error: bool, ) -> Result<Self, VulkanError>

Create the VulkanShader from source code

• level: You could use one of these: OptimizationLevel::Zero, OptimizationLevel::Size, and OptimizationLevel::Performance

pub fn new_from_source_file( device: Arc<VulkanDevice>, code_path: ShaderSourcePath, is_hlsl: bool, entry_point: &str, level: OptimizationLevel, warning_as_error: bool, ) -> Result<Self, VulkanError>

Create the VulkanShader from source code from file

• level: You could use one of these: OptimizationLevel::Zero, OptimizationLevel::Size, and OptimizationLevel::Performance

pub fn new_from_source_file_or_cache( device: Arc<VulkanDevice>, code_path: ShaderSourcePath, is_hlsl: bool, entry_point: &str, level: OptimizationLevel, warning_as_error: bool, ) -> Result<Self, VulkanError>

Create the VulkanShader from source code from file or load from cached binary code

• level: You could use one of these: OptimizationLevel::Zero, OptimizationLevel::Size, and OptimizationLevel::Performance

Overwrite

See VulkanShader::load_cache_or_compile

pub fn get_entry_point(&self) -> &CString

Get the entry point

pub fn get_vars(&self) -> &[Arc<ShaderVariable>]

Get variables

pub fn get_tessellation_output_vertices(&self) -> Option<u32>

Get the tessellation output vertices

Trait Implementations

impl Debug for VulkanShader

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

Formats the value using the given formatter.

impl Drop for VulkanShader

fn drop(&mut self)

Executes the destructor for this type.