Vulkan.Core10.Shader

Documentation

createShaderModule

Arguments

:: forall a io. (Extendss ShaderModuleCreateInfo a, PokeChain a, MonadIO io)

=> Device

device is the logical device that creates the shader module.

-> ShaderModuleCreateInfo a

pCreateInfo is a pointer to a ShaderModuleCreateInfo structure.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ShaderModule

vkCreateShaderModule - Creates a new shader module object

Description

Once a shader module has been created, any entry points it contains can be used in pipeline shader stages as described in Compute Pipelines and Graphics Pipelines.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid ShaderModuleCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pShaderModule must be a valid pointer to a ShaderModule handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INVALID_SHADER_NV

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, ShaderModule, ShaderModuleCreateInfo

withShaderModule :: forall a io r. (Extendss ShaderModuleCreateInfo a, PokeChain a, MonadIO io) => Device -> ShaderModuleCreateInfo a -> Maybe AllocationCallbacks -> (io ShaderModule -> (ShaderModule -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createShaderModule and destroyShaderModule

To ensure that destroyShaderModule is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyShaderModule

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the shader module.

-> ShaderModule

shaderModule is the handle of the shader module to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

vkDestroyShaderModule - Destroy a shader module

Description

A shader module can be destroyed while pipelines created using its shaders are still in use.

Valid Usage

• If AllocationCallbacks were provided when shaderModule was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when shaderModule was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If shaderModule is not NULL_HANDLE, shaderModule must be a valid ShaderModule handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If shaderModule is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to shaderModule must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, ShaderModule

data ShaderModuleCreateInfo (es :: [Type])

VkShaderModuleCreateInfo - Structure specifying parameters of a newly created shader module

Valid Usage

• codeSize must be greater than 0

• If pCode is a pointer to SPIR-V code, codeSize must be a multiple of 4
• pCode must point to either valid SPIR-V code, formatted and packed as described by the Khronos SPIR-V Specification or valid GLSL code which must be written to the GL_KHR_vulkan_glsl extension specification
• If pCode is a pointer to SPIR-V code, that code must adhere to the validation rules described by the Validation Rules within a Module section of the SPIR-V Environment appendix
• If pCode is a pointer to GLSL code, it must be valid GLSL code written to the GL_KHR_vulkan_glsl GLSL extension specification
• pCode must declare the Shader capability for SPIR-V code
• pCode must not declare any capability that is not supported by the API, as described by the Capabilities section of the SPIR-V Environment appendix
• If pCode declares any of the capabilities listed in the SPIR-V Environment appendix, one of the corresponding requirements must be satisfied
• pCode must not declare any SPIR-V extension that is not supported by the API, as described by the Extension section of the SPIR-V Environment appendix
• If pCode declares any of the SPIR-V extensions listed in the SPIR-V Environment appendix, one of the corresponding requirements must be satisfied

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of ShaderModuleValidationCacheCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be 0
• pCode must be a valid pointer to an array of \(\textrm{codeSize} \over 4\) uint32_t values

See Also

VK_VERSION_1_0, ShaderModuleCreateFlags, StructureType, createShaderModule

Constructors

ShaderModuleCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: ShaderModuleCreateFlags

  flags is reserved for future use.

• code :: ByteString

  pCode is a pointer to code that is used to create the shader module. The type and format of the code is determined from the content of the memory addressed by pCode.

Instances

Extensible ShaderModuleCreateInfo

Defined in Vulkan.Core10.Shader

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). ShaderModuleCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). ShaderModuleCreateInfo ds -> Chain es -> ShaderModuleCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends ShaderModuleCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (ShaderModuleCreateInfo es)

Defined in Vulkan.Core10.Shader

Methods

showsPrec :: Int -> ShaderModuleCreateInfo es -> ShowS

show :: ShaderModuleCreateInfo es -> String

showList :: [ShaderModuleCreateInfo es] -> ShowS

(Extendss ShaderModuleCreateInfo es, PeekChain es) => FromCStruct (ShaderModuleCreateInfo es)

Defined in Vulkan.Core10.Shader

Methods

peekCStruct :: Ptr (ShaderModuleCreateInfo es) -> IO (ShaderModuleCreateInfo es)

(Extendss ShaderModuleCreateInfo es, PokeChain es) => ToCStruct (ShaderModuleCreateInfo es)

Defined in Vulkan.Core10.Shader

Methods

withCStruct :: ShaderModuleCreateInfo es -> (Ptr (ShaderModuleCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (ShaderModuleCreateInfo es) -> ShaderModuleCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (ShaderModuleCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (ShaderModuleCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (ShaderModuleCreateInfo es)

Defined in Vulkan.Core10.Shader

Methods

zero :: ShaderModuleCreateInfo es

newtype ShaderModule

VkShaderModule - Opaque handle to a shader module object

See Also

VK_VERSION_1_0, PipelineShaderStageCreateInfo, createShaderModule, destroyShaderModule

Constructors

ShaderModule Word64

Instances

Eq ShaderModule

Defined in Vulkan.Core10.Handles

Methods

(==) :: ShaderModule -> ShaderModule -> Bool

(/=) :: ShaderModule -> ShaderModule -> Bool

Ord ShaderModule

Defined in Vulkan.Core10.Handles

Methods

compare :: ShaderModule -> ShaderModule -> Ordering

(<) :: ShaderModule -> ShaderModule -> Bool

(<=) :: ShaderModule -> ShaderModule -> Bool

(>) :: ShaderModule -> ShaderModule -> Bool

(>=) :: ShaderModule -> ShaderModule -> Bool

max :: ShaderModule -> ShaderModule -> ShaderModule

min :: ShaderModule -> ShaderModule -> ShaderModule

Show ShaderModule

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> ShaderModule -> ShowS

show :: ShaderModule -> String

showList :: [ShaderModule] -> ShowS

Storable ShaderModule

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: ShaderModule -> Int

alignment :: ShaderModule -> Int

peekElemOff :: Ptr ShaderModule -> Int -> IO ShaderModule

pokeElemOff :: Ptr ShaderModule -> Int -> ShaderModule -> IO ()

peekByteOff :: Ptr b -> Int -> IO ShaderModule

pokeByteOff :: Ptr b -> Int -> ShaderModule -> IO ()

peek :: Ptr ShaderModule -> IO ShaderModule

poke :: Ptr ShaderModule -> ShaderModule -> IO ()

Zero ShaderModule

Defined in Vulkan.Core10.Handles

Methods

zero :: ShaderModule

HasObjectType ShaderModule

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: ShaderModule -> (ObjectType, Word64)

IsHandle ShaderModule

Defined in Vulkan.Core10.Handles

newtype ShaderModuleCreateFlags

VkShaderModuleCreateFlags - Reserved for future use

Description

ShaderModuleCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_VERSION_1_0, ShaderModuleCreateInfo

Constructors

ShaderModuleCreateFlags Flags

Instances

Eq ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

(==) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

(/=) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

Ord ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

compare :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Ordering

(<) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

(<=) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

(>) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

(>=) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> Bool

max :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> ShaderModuleCreateFlags

min :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> ShaderModuleCreateFlags

Read ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

readsPrec :: Int -> ReadS ShaderModuleCreateFlags

readList :: ReadS [ShaderModuleCreateFlags]

readPrec :: ReadPrec ShaderModuleCreateFlags

readListPrec :: ReadPrec [ShaderModuleCreateFlags]

Show ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

showsPrec :: Int -> ShaderModuleCreateFlags -> ShowS

show :: ShaderModuleCreateFlags -> String

showList :: [ShaderModuleCreateFlags] -> ShowS

Storable ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

sizeOf :: ShaderModuleCreateFlags -> Int

alignment :: ShaderModuleCreateFlags -> Int

peekElemOff :: Ptr ShaderModuleCreateFlags -> Int -> IO ShaderModuleCreateFlags

pokeElemOff :: Ptr ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags -> IO ()

peekByteOff :: Ptr b -> Int -> IO ShaderModuleCreateFlags

pokeByteOff :: Ptr b -> Int -> ShaderModuleCreateFlags -> IO ()

peek :: Ptr ShaderModuleCreateFlags -> IO ShaderModuleCreateFlags

poke :: Ptr ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> IO ()

Bits ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

(.&.) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> ShaderModuleCreateFlags

(.|.) :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> ShaderModuleCreateFlags

xor :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags -> ShaderModuleCreateFlags

complement :: ShaderModuleCreateFlags -> ShaderModuleCreateFlags

shift :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

rotate :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

zeroBits :: ShaderModuleCreateFlags

bit :: Int -> ShaderModuleCreateFlags

setBit :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

clearBit :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

complementBit :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

testBit :: ShaderModuleCreateFlags -> Int -> Bool

bitSizeMaybe :: ShaderModuleCreateFlags -> Maybe Int

bitSize :: ShaderModuleCreateFlags -> Int

isSigned :: ShaderModuleCreateFlags -> Bool

shiftL :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

unsafeShiftL :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

shiftR :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

unsafeShiftR :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

rotateL :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

rotateR :: ShaderModuleCreateFlags -> Int -> ShaderModuleCreateFlags

popCount :: ShaderModuleCreateFlags -> Int

FiniteBits ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

finiteBitSize :: ShaderModuleCreateFlags -> Int

countLeadingZeros :: ShaderModuleCreateFlags -> Int

countTrailingZeros :: ShaderModuleCreateFlags -> Int

Zero ShaderModuleCreateFlags

Defined in Vulkan.Core10.Enums.ShaderModuleCreateFlags

Methods

zero :: ShaderModuleCreateFlags