Package org.lwjgl.vulkan
Class VkDeviceCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDeviceCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDeviceCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how to create a device.
Valid Usage
sTypemust beSTRUCTURE_TYPE_DEVICE_CREATE_INFOpNextmust beNULLflagsmust be 0pQueueCreateInfosmust be a pointer to an array ofqueueCreateInfoCountvalidVkDeviceQueueCreateInfostructures- If
enabledLayerCountis not 0,ppEnabledLayerNamesmust be a pointer to an array ofenabledLayerCountnull-terminated strings - If
enabledExtensionCountis not 0,ppEnabledExtensionNamesmust be a pointer to an array ofenabledExtensionCountnull-terminated strings - If
pEnabledFeaturesis notNULL,pEnabledFeaturesmust be a pointer to a validVkPhysicalDeviceFeaturesstructure queueCreateInfoCountmust be greater than 0ppEnabledLayerNamesmust either beNULLor contain the same sequence of layer names that was enabled when creating the parent instance- Any given element of
ppEnabledExtensionNamesmust be the name of an extension present on the system, exactly matching a string returned in theVkExtensionPropertiesstructure byEnumerateDeviceExtensionProperties - If an extension listed in
ppEnabledExtensionNamesis provided as part of a layer, then both the layer and extension must be enabled to enable that extension - The
queueFamilyIndexmember of any given element ofpQueueCreateInfosmust be unique withinpQueueCreateInfos
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_DEVICE_CREATE_INFOpNext– reserved for use by extensionsflags– reserved for future usequeueCreateInfoCount– the unsigned integer size of thepQueueCreateInfosarraypQueueCreateInfos– a pointer to an array ofVkDeviceQueueCreateInfostructures describing the queues that are requested to be created along with the logical deviceenabledLayerCount– deprecated and ignoredppEnabledLayerNames– deprecated and ignoredenabledExtensionCount– the number of device extensions to enableppEnabledExtensionNames– a pointer to an array ofenabledExtensionCountnull-terminated UTF-8 strings containing the names of extensions to enable for the created devicepEnabledFeatures–NULLor a pointer to aVkPhysicalDeviceFeaturesstructure that contains boolean indicators of all the features to be enabled
Layout
struct VkDeviceCreateInfo { VkStructureType sType; const void * pNext; VkDeviceCreateFlags flags; uint32_t queueCreateInfoCount; const VkDeviceQueueCreateInfo * pQueueCreateInfos; uint32_t enabledLayerCount; const char * const * ppEnabledLayerNames; uint32_t enabledExtensionCount; const char * const * ppEnabledExtensionNames; const VkPhysicalDeviceFeatures * pEnabledFeatures; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkDeviceCreateInfo.BufferAn array ofVkDeviceCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkDeviceCreateInfo(java.nio.ByteBuffer container)Creates aVkDeviceCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkDeviceCreateInfocalloc()Returns a newVkDeviceCreateInfoinstance allocated withmemCalloc.static VkDeviceCreateInfo.Buffercalloc(int capacity)Returns a newVkDeviceCreateInfo.Bufferinstance allocated withmemCalloc.static VkDeviceCreateInfocallocStack()Returns a newVkDeviceCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDeviceCreateInfo.BuffercallocStack(int capacity)Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDeviceCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceCreateInfocallocStack(MemoryStack stack)Returns a newVkDeviceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceCreateInfocreate()Returns a newVkDeviceCreateInfoinstance allocated withBufferUtils.static VkDeviceCreateInfo.Buffercreate(int capacity)Returns a newVkDeviceCreateInfo.Bufferinstance allocated withBufferUtils.static VkDeviceCreateInfocreate(long address)Returns a newVkDeviceCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkDeviceCreateInfo.Buffercreate(long address, int capacity)Create aVkDeviceCreateInfo.Bufferinstance at the specified memory.intenabledExtensionCount()Returns the value of theenabledExtensionCountfield.intenabledLayerCount()Returns the value of theenabledLayerCountfield.intflags()Returns the value of theflagsfield.VkDeviceCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkDeviceCreateInfomalloc()Returns a newVkDeviceCreateInfoinstance allocated withmemAlloc.static VkDeviceCreateInfo.Buffermalloc(int capacity)Returns a newVkDeviceCreateInfo.Bufferinstance allocated withmemAlloc.static VkDeviceCreateInfomallocStack()Returns a newVkDeviceCreateInfoinstance allocated on the thread-localMemoryStack.static VkDeviceCreateInfo.BuffermallocStack(int capacity)Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkDeviceCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDeviceCreateInfomallocStack(MemoryStack stack)Returns a newVkDeviceCreateInfoinstance allocated on the specifiedMemoryStack.VkDeviceCreateInfonset(long struct)Unsafe version ofset.VkPhysicalDeviceFeaturespEnabledFeatures()Returns aVkPhysicalDeviceFeaturesview of the struct pointed to by thepEnabledFeaturesfield.VkDeviceCreateInfopEnabledFeatures(VkPhysicalDeviceFeatures value)Sets the address of the specifiedVkPhysicalDeviceFeaturesto thepEnabledFeaturesfield.longpNext()Returns the value of thepNextfield.VkDeviceCreateInfopNext(long value)Sets the specified value to thepNextfield.PointerBufferppEnabledExtensionNames()Returns aPointerBufferview of the data pointed to by theppEnabledExtensionNamesfield.VkDeviceCreateInfoppEnabledExtensionNames(PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.PointerBufferppEnabledLayerNames()Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.VkDeviceCreateInfoppEnabledLayerNames(PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.VkDeviceQueueCreateInfo.BufferpQueueCreateInfos()Returns aVkDeviceQueueCreateInfo.Bufferview of the struct array pointed to by thepQueueCreateInfosfield.VkDeviceCreateInfopQueueCreateInfos(VkDeviceQueueCreateInfo.Buffer value)Sets the address of the specifiedVkDeviceQueueCreateInfo.Bufferto thepQueueCreateInfosfield.intqueueCreateInfoCount()Returns the value of thequeueCreateInfoCountfield.VkDeviceCreateInfoset(int sType, long pNext, int flags, VkDeviceQueueCreateInfo.Buffer pQueueCreateInfos, PointerBuffer ppEnabledLayerNames, PointerBuffer ppEnabledExtensionNames, VkPhysicalDeviceFeatures pEnabledFeatures)Initializes this struct with the specified values.VkDeviceCreateInfoset(VkDeviceCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkDeviceCreateInfosType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)CallsVkDeviceCreateInfo.validate(long)for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkDeviceCreateInfo
public VkDeviceCreateInfo(java.nio.ByteBuffer container)
Creates aVkDeviceCreateInfoinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
queueCreateInfoCount
public int queueCreateInfoCount()
Returns the value of thequeueCreateInfoCountfield.
-
pQueueCreateInfos
public VkDeviceQueueCreateInfo.Buffer pQueueCreateInfos()
Returns aVkDeviceQueueCreateInfo.Bufferview of the struct array pointed to by thepQueueCreateInfosfield.
-
enabledLayerCount
public int enabledLayerCount()
Returns the value of theenabledLayerCountfield.
-
ppEnabledLayerNames
public PointerBuffer ppEnabledLayerNames()
Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.
-
enabledExtensionCount
public int enabledExtensionCount()
Returns the value of theenabledExtensionCountfield.
-
ppEnabledExtensionNames
public PointerBuffer ppEnabledExtensionNames()
Returns aPointerBufferview of the data pointed to by theppEnabledExtensionNamesfield.
-
pEnabledFeatures
public VkPhysicalDeviceFeatures pEnabledFeatures()
Returns aVkPhysicalDeviceFeaturesview of the struct pointed to by thepEnabledFeaturesfield.
-
sType
public VkDeviceCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDeviceCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkDeviceCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
pQueueCreateInfos
public VkDeviceCreateInfo pQueueCreateInfos(VkDeviceQueueCreateInfo.Buffer value)
Sets the address of the specifiedVkDeviceQueueCreateInfo.Bufferto thepQueueCreateInfosfield.
-
ppEnabledLayerNames
public VkDeviceCreateInfo ppEnabledLayerNames(PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.
-
ppEnabledExtensionNames
public VkDeviceCreateInfo ppEnabledExtensionNames(PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.
-
pEnabledFeatures
public VkDeviceCreateInfo pEnabledFeatures(VkPhysicalDeviceFeatures value)
Sets the address of the specifiedVkPhysicalDeviceFeaturesto thepEnabledFeaturesfield.
-
set
public VkDeviceCreateInfo set(int sType, long pNext, int flags, VkDeviceQueueCreateInfo.Buffer pQueueCreateInfos, PointerBuffer ppEnabledLayerNames, PointerBuffer ppEnabledExtensionNames, VkPhysicalDeviceFeatures pEnabledFeatures)
Initializes this struct with the specified values.
-
nset
public VkDeviceCreateInfo nset(long struct)
Unsafe version ofset.
-
set
public VkDeviceCreateInfo set(VkDeviceCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDeviceCreateInfo malloc()
Returns a newVkDeviceCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDeviceCreateInfo calloc()
Returns a newVkDeviceCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDeviceCreateInfo create()
Returns a newVkDeviceCreateInfoinstance allocated withBufferUtils.
-
create
public static VkDeviceCreateInfo create(long address)
Returns a newVkDeviceCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkDeviceCreateInfo.Buffer malloc(int capacity)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDeviceCreateInfo.Buffer calloc(int capacity)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceCreateInfo.Buffer create(int capacity)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceCreateInfo.Buffer create(long address, int capacity)
Create aVkDeviceCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkDeviceCreateInfo mallocStack()
Returns a newVkDeviceCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDeviceCreateInfo callocStack()
Returns a newVkDeviceCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDeviceCreateInfo mallocStack(MemoryStack stack)
Returns a newVkDeviceCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDeviceCreateInfo callocStack(MemoryStack stack)
Returns a newVkDeviceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkDeviceCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDeviceCreateInfo.Buffer callocStack(int capacity)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDeviceCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkDeviceCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)CallsVkDeviceCreateInfo.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-