Package org.lwjgl.vulkan
Class VkShaderModuleCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkShaderModuleCreateInfo>
org.lwjgl.vulkan.VkShaderModuleCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkShaderModuleCreateInfo
extends org.lwjgl.system.Struct<VkShaderModuleCreateInfo>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created shader module.
Valid Usage
- If pCode is a pointer to SPIR-V code,
codeSizemust be a multiple of 4 - If pCode is a pointer to SPIR-V code,
pCodemust point to valid SPIR-V code, formatted and packed as described by the Khronos SPIR-V Specification - If pCode is a pointer to SPIR-V code,
pCodemust 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 SPIR-V code,
pCodemust declare theShadercapability for SPIR-V code - If pCode is a pointer to SPIR-V code,
pCodemust 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 is a pointer to SPIR-V code, and
pCodedeclares any of the capabilities listed in the SPIR-V Environment appendix, one of the corresponding requirements must be satisfied - If pCode is a pointer to SPIR-V code,
pCodemust 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 is a pointer to SPIR-V code, and
pCodedeclares any of the SPIR-V extensions listed in the SPIR-V Environment appendix, one of the corresponding requirements must be satisfied - If the
VK_NV_glsl_shaderextension is not enabled,pCodemust be a pointer to SPIR-V code - If
pCodeis a pointer to GLSL code, it must be valid GLSL code written to theGL_KHR_vulkan_glslGLSL extension specification codeSizemust be greater than 0
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SHADER_MODULE_CREATE_INFOflagsmust be 0pCodemust be a valid pointer to an array ofcodeSize / 4uint32_tvalues
See Also
CreateShaderModule, GetShaderModuleCreateInfoIdentifierEXT
Layout
struct VkShaderModuleCreateInfo {
VkStructureType sType();
void const * pNext();
VkShaderModuleCreateFlags flags();
size_t codeSize();
uint32_t const * pCode();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkShaderModuleCreateInfo(ByteBuffer container) Creates aVkShaderModuleCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkShaderModuleCreateInfocalloc()Returns a newVkShaderModuleCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkShaderModuleCreateInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkShaderModuleCreateInfoDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkShaderModuleCreateInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.longcodeSize()the size, in bytes, of the code pointed to bypCode.static VkShaderModuleCreateInfocreate()Returns a newVkShaderModuleCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withBufferUtils.static VkShaderModuleCreateInfocreate(long address) Returns a newVkShaderModuleCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkShaderModuleCreateInfo.Bufferinstance at the specified memory.static @Nullable VkShaderModuleCreateInfocreateSafe(long address) static @Nullable VkShaderModuleCreateInfo.BuffercreateSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.static VkShaderModuleCreateInfomalloc()Returns a newVkShaderModuleCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkShaderModuleCreateInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfoinstance allocated on the specifiedMemoryStack.static VkShaderModuleCreateInfoDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkShaderModuleCreateInfomallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longncodeSize(long struct) Unsafe version ofcodeSize().static voidncodeSize(long struct, long value) Sets the specified value to thecodeSizefield of the specifiedstruct.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static ByteBuffernpCode(long struct) Unsafe version ofpCode.static voidnpCode(long struct, ByteBuffer value) Unsafe version ofpCode.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.pCode()points to code that is used to create the shader modulepCode(ByteBuffer value) Sets the address of the specifiedByteBufferto thepCode()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkShaderModuleValidationCacheCreateInfoEXTvalue to thepNextchain.pNext(VkValidationFeaturesEXT value) Prepends the specifiedVkValidationFeaturesEXTvalue to thepNextchain.set(int sType, long pNext, int flags, ByteBuffer pCode) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SHADER_MODULE_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
CODESIZE
public static final int CODESIZEThe struct member offsets. -
PCODE
public static final int PCODEThe struct member offsets.
-
-
Constructor Details
-
VkShaderModuleCreateInfo
Creates aVkShaderModuleCreateInfoinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkShaderModuleCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
codeSize
public long codeSize()the size, in bytes, of the code pointed to bypCode. -
pCode
points to code that is used to create the shader module -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SHADER_MODULE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkShaderModuleValidationCacheCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkValidationFeaturesEXTvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
pCode
Sets the address of the specifiedByteBufferto thepCode()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkShaderModuleCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkShaderModuleCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkShaderModuleCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkShaderModuleCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkShaderModuleCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkShaderModuleCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkShaderModuleCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkShaderModuleCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkShaderModuleCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkShaderModuleCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkShaderModuleCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkShaderModuleCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ncodeSize
public static long ncodeSize(long struct) Unsafe version ofcodeSize(). -
npCode
Unsafe version ofpCode. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ncodeSize
public static void ncodeSize(long struct, long value) Sets the specified value to thecodeSizefield of the specifiedstruct. -
npCode
Unsafe version ofpCode. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-