Struct vulkano::pipeline::shader::ShaderModule[−][src]

pub struct ShaderModule { /* fields omitted */ }

Contains SPIR-V code with one or more entry points.

Note that it is advised to wrap around a ShaderModule with a struct that is different for each shader.

Implementations

impl ShaderModule[src]

pub unsafe fn new(
    device: Arc<Device>,
    spirv: &[u8]
) -> Result<Arc<ShaderModule>, OomError>[src]

Builds a new shader module from SPIR-V bytes.

Safety

  • The SPIR-V code is not validated.
  • The SPIR-V code may require some features that are not enabled. This isn’t checked by this function either.

pub unsafe fn from_words(
    device: Arc<Device>,
    spirv: &[u32]
) -> Result<Arc<ShaderModule>, OomError>[src]

Builds a new shader module from SPIR-V 32-bit words.

Safety

  • The SPIR-V code is not validated.
  • The SPIR-V code may require some features that are not enabled. This isn’t checked by this function either.

pub unsafe fn graphics_entry_point<'a, S, I, O, L>(
    &'a self,
    name: &'a CStr,
    input: I,
    output: O,
    layout: L,
    ty: GraphicsShaderType
) -> GraphicsEntryPoint<'a, S, I, O, L>[src]

Gets access to an entry point contained in this module.

This is purely a logical operation. It returns a struct that represents the entry point but doesn’t actually do anything.

Safety

  • The user must check that the entry point exists in the module, as this is not checked by Vulkan.
  • The input, output and layout must correctly describe the input, output and layout used by this stage.

pub unsafe fn compute_entry_point<'a, S, L>(
    &'a self,
    name: &'a CStr,
    layout: L
) -> ComputeEntryPoint<'a, S, L>[src]

Gets access to an entry point contained in this module.

This is purely a logical operation. It returns a struct that represents the entry point but doesn’t actually do anything.

Safety

  • The user must check that the entry point exists in the module, as this is not checked by Vulkan.
  • The layout must correctly describe the layout used by this stage.

Trait Implementations

impl Debug for ShaderModule[src]

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

Formats the value using the given formatter. Read more

impl Drop for ShaderModule[src]

fn drop(&mut self)[src]

Executes the destructor for this type. Read more

impl VulkanObject for ShaderModule[src]

type Object = ShaderModule

The type of the object.

const TYPE: ObjectType[src]

The ObjectType of the internal Vulkan handle.

fn internal_object(&self) -> ShaderModule[src]

Returns a reference to the object.

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Content for T[src]

pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>[src]

Builds a pointer to this type from a raw pointer.

pub fn is_size_suitable(usize) -> bool[src]

Returns true if the size is suitable to store a type like this.

pub fn indiv_size() -> usize[src]

Returns the size of an individual element.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.