Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkShaderModuleCreateInfo

extends Struct<VkShaderModuleCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of a newly created shader module.
Valid Usage
Valid Usage (Implicit)
See Also

CreateShaderModule, GetShaderModuleCreateInfoIdentifierEXT

Layout


struct VkShaderModuleCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkShaderModuleCreateFlags flags;
    size_t codeSize;
    uint32_t const * pCode;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CODESIZE

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PCODE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkShaderModuleCreateInfo(long address, ByteBuffer container)

public
VkShaderModuleCreateInfo(ByteBuffer container)

Creates a VkShaderModuleCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkShaderModuleCreateInfo
calloc()

Returns a new VkShaderModuleCreateInfo instance allocated with memCalloc.

public static VkShaderModuleCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memCalloc.

public static VkShaderModuleCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkShaderModuleCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkShaderModuleCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
codeSize()

the size, in bytes, of the code pointed to by pCode.

protected VkShaderModuleCreateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkShaderModuleCreateInfo
create()

Returns a new VkShaderModuleCreateInfo instance allocated with BufferUtils.

public static VkShaderModuleCreateInfo
create(long address)

Returns a new VkShaderModuleCreateInfo instance for the specified memory address.

public static VkShaderModuleCreateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with BufferUtils.

public static VkShaderModuleCreateInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkShaderModuleCreateInfo.Buffer instance at the specified memory.

public static VkShaderModuleCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkShaderModuleCreateInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkShaderModuleCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VkShaderModuleCreateInfo
malloc()

Returns a new VkShaderModuleCreateInfo instance allocated with memAlloc.

public static VkShaderModuleCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memAlloc.

public static VkShaderModuleCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack.

public static VkShaderModuleCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the specified MemoryStack.

public static VkShaderModuleCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShaderModuleCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
ncodeSize(long struct)

Unsafe version of codeSize.

public static void
ncodeSize(long struct, long value)

Sets the specified value to the codeSize field of the specified struct.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static ByteBuffer
npCode(long struct)

Unsafe version of pCode.

public static void
npCode(long struct, ByteBuffer value)

Unsafe version of pCode.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public ByteBuffer
pCode()

points to code that is used to create the shader module

public VkShaderModuleCreateInfo
pCode(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pCode field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkShaderModuleCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkShaderModuleCreateInfo
public VkShaderModuleCreateInfo
set(int sType, long pNext, int flags, ByteBuffer pCode)

Initializes this struct with the specified values.

public VkShaderModuleCreateInfo

Returns:

this struct
set
(VkShaderModuleCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkShaderModuleCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkShaderModuleCreateInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CODESIZEback to summary
public static final int CODESIZE

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PCODEback to summary
public static final int PCODE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkShaderModuleCreateInfoback to summary
protected VkShaderModuleCreateInfo(long address, ByteBuffer container)
VkShaderModuleCreateInfoback to summary
public VkShaderModuleCreateInfo(ByteBuffer container)

Creates a VkShaderModuleCreateInfo instance at the current position of the specified ByteBuffer container. 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 Detail

callocback to summary
public static VkShaderModuleCreateInfo calloc()

Returns a new VkShaderModuleCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkShaderModuleCreateInfo.Buffer calloc(int capacity)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkShaderModuleCreateInfo calloc(MemoryStack stack)

Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkShaderModuleCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkShaderModuleCreateInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkShaderModuleCreateInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkShaderModuleCreateInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkShaderModuleCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
codeSizeback to summary
public long codeSize()

the size, in bytes, of the code pointed to by pCode.

Annotations
@NativeType:size_t
createback to summary
protected VkShaderModuleCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkShaderModuleCreateInfo create()

Returns a new VkShaderModuleCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkShaderModuleCreateInfo create(long address)

Returns a new VkShaderModuleCreateInfo instance for the specified memory address.

createback to summary
public static VkShaderModuleCreateInfo.Buffer create(int capacity)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkShaderModuleCreateInfo.Buffer create(long address, int capacity)

Create a VkShaderModuleCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkShaderModuleCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkShaderModuleCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkShaderModuleCreateFlags
flagsback to summary
public VkShaderModuleCreateInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkShaderModuleCreateInfo malloc()

Returns a new VkShaderModuleCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkShaderModuleCreateInfo.Buffer malloc(int capacity)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkShaderModuleCreateInfo malloc(MemoryStack stack)

Returns a new VkShaderModuleCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkShaderModuleCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkShaderModuleCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkShaderModuleCreateInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkShaderModuleCreateInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkShaderModuleCreateInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkShaderModuleCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ncodeSizeback to summary
public static long ncodeSize(long struct)

Unsafe version of codeSize.

ncodeSizeback to summary
public static void ncodeSize(long struct, long value)

Sets the specified value to the codeSize field of the specified struct.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npCodeback to summary
public static ByteBuffer npCode(long struct)

Unsafe version of pCode.

npCodeback to summary
public static void npCode(long struct, ByteBuffer value)

Unsafe version of pCode.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pCodeback to summary
public ByteBuffer pCode()

points to code that is used to create the shader module

Annotations
@NativeType:uint32_t const *
pCodeback to summary
public VkShaderModuleCreateInfo pCode(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pCode field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkShaderModuleCreateInfo pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkShaderModuleCreateInfo pNext(VkShaderModuleValidationCacheCreateInfoEXT value)

Prepends the specified VkShaderModuleValidationCacheCreateInfoEXT value to the pNext chain.

setback to summary
public VkShaderModuleCreateInfo set(int sType, long pNext, int flags, ByteBuffer pCode)

Initializes this struct with the specified values.

setback to summary
public VkShaderModuleCreateInfo set(VkShaderModuleCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkShaderModuleCreateInfo

the source struct

Returns:VkShaderModuleCreateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkShaderModuleCreateInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkShaderModuleCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkShaderModuleCreateInfo.Buffer

extends StructBuffer<VkShaderModuleCreateInfo, VkShaderModuleCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkShaderModuleCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkShaderModuleCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkShaderModuleCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkShaderModuleCreateInfo#codeSize field.
codeSize
()

public int

Returns:

the value of the VkShaderModuleCreateInfo#flags field.
flags
()

public VkShaderModuleCreateInfo.Buffer
flags(int value)

Sets the specified value to the VkShaderModuleCreateInfo#flags field.

protected VkShaderModuleCreateInfo
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the VkShaderModuleCreateInfo#pCode field.
pCode
()

public VkShaderModuleCreateInfo.Buffer
pCode(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkShaderModuleCreateInfo#pCode field.

public long

Returns:

the value of the VkShaderModuleCreateInfo#pNext field.
pNext
()

public VkShaderModuleCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkShaderModuleCreateInfo#pNext field.

public VkShaderModuleCreateInfo.Buffer
protected VkShaderModuleCreateInfo.Buffer
public int

Returns:

the value of the VkShaderModuleCreateInfo#sType field.
sType
()

public VkShaderModuleCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkShaderModuleCreateInfo#sType field.

public VkShaderModuleCreateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkShaderModuleCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkShaderModuleCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkShaderModuleCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

codeSizeback to summary
public long codeSize()
Returns:long

the value of the VkShaderModuleCreateInfo#codeSize field.

Annotations
@NativeType:size_t
flagsback to summary
public int flags()
Returns:int

the value of the VkShaderModuleCreateInfo#flags field.

Annotations
@NativeType:VkShaderModuleCreateFlags
flagsback to summary
public VkShaderModuleCreateInfo.Buffer flags(int value)

Sets the specified value to the VkShaderModuleCreateInfo#flags field.

getElementFactoryback to summary
protected VkShaderModuleCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pCodeback to summary
public ByteBuffer pCode()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the VkShaderModuleCreateInfo#pCode field.

Annotations
@NativeType:uint32_t const *
pCodeback to summary
public VkShaderModuleCreateInfo.Buffer pCode(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkShaderModuleCreateInfo#pCode field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkShaderModuleCreateInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkShaderModuleCreateInfo.Buffer pNext(long value)

Sets the specified value to the VkShaderModuleCreateInfo#pNext field.

pNextback to summary
public VkShaderModuleCreateInfo.Buffer pNext(VkShaderModuleValidationCacheCreateInfoEXT value)

Prepends the specified VkShaderModuleValidationCacheCreateInfoEXT value to the pNext chain.

selfback to summary
protected VkShaderModuleCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkShaderModuleCreateInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkShaderModuleCreateInfo.Buffer sType(int value)

Sets the specified value to the VkShaderModuleCreateInfo#sType field.

sType$Defaultback to summary
public VkShaderModuleCreateInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO value to the VkShaderModuleCreateInfo#sType field.