Package org.lwjgl.vulkan
Class VkImageCreateInfo
- All Implemented Interfaces:
AutoCloseable,NativeResource,Pointer
struct VkImageCreateInfo {
VkStructureType sType;
void const * pNext;
VkImageCreateFlags flags;
VkImageType imageType;
VkFormat format;
{@link VkExtent3D VkExtent3D} extent;
uint32_t mipLevels;
uint32_t arrayLayers;
VkSampleCountFlagBits samples;
VkImageTiling tiling;
VkImageUsageFlags usage;
VkSharingMode sharingMode;
uint32_t queueFamilyIndexCount;
uint32_t const * pQueueFamilyIndices;
VkImageLayout initialLayout;
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
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 member offsets.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 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.static final intThe struct member offsets.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
ConstructorsConstructorDescriptionVkImageCreateInfo(ByteBuffer container) Creates aVkImageCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintarrayLayers(int value) Sets the specified value to thearrayLayersfield.static VkImageCreateInfocalloc()Returns a newVkImageCreateInfoinstance allocated withmemCalloc.static VkImageCreateInfo.Buffercalloc(int capacity) Returns a newVkImageCreateInfo.Bufferinstance allocated withmemCalloc.static VkImageCreateInfo.Buffercalloc(int capacity, MemoryStack stack) Returns a newVkImageCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageCreateInfocalloc(MemoryStack stack) Returns a newVkImageCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageCreateInfoDeprecated.static VkImageCreateInfo.BuffercallocStack(int capacity) Deprecated.static VkImageCreateInfo.BuffercallocStack(int capacity, MemoryStack stack) Deprecated.static VkImageCreateInfocallocStack(MemoryStack stack) Deprecated.static VkImageCreateInfocreate()Returns a newVkImageCreateInfoinstance allocated withBufferUtils.static VkImageCreateInfo.Buffercreate(int capacity) Returns a newVkImageCreateInfo.Bufferinstance allocated withBufferUtils.static VkImageCreateInfocreate(long address) Returns a newVkImageCreateInfoinstance for the specified memory address.static VkImageCreateInfo.Buffercreate(long address, int capacity) Create aVkImageCreateInfo.Bufferinstance at the specified memory.static @Nullable VkImageCreateInfocreateSafe(long address) static @Nullable VkImageCreateInfo.BuffercreateSafe(long address, int capacity) extent()extent(Consumer<VkExtent3D> consumer) Passes theextentfield to the specifiedConsumer.extent(VkExtent3D value) Copies the specifiedVkExtent3Dto theextentfield.intflags()flags(int value) Sets the specified value to theflagsfield.intformat()format(int value) Sets the specified value to theformatfield.intimageType(int value) Sets the specified value to theimageTypefield.intinitialLayout(int value) Sets the specified value to theinitialLayoutfield.static VkImageCreateInfomalloc()Returns a newVkImageCreateInfoinstance allocated withmemAlloc.static VkImageCreateInfo.Buffermalloc(int capacity) Returns a newVkImageCreateInfo.Bufferinstance allocated withmemAlloc.static VkImageCreateInfo.Buffermalloc(int capacity, MemoryStack stack) Returns a newVkImageCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkImageCreateInfomalloc(MemoryStack stack) Returns a newVkImageCreateInfoinstance allocated on the specifiedMemoryStack.static VkImageCreateInfoDeprecated.static VkImageCreateInfo.BuffermallocStack(int capacity) Deprecated.static VkImageCreateInfo.BuffermallocStack(int capacity, MemoryStack stack) Deprecated.static VkImageCreateInfomallocStack(MemoryStack stack) Deprecated.intmipLevels(int value) Sets the specified value to themipLevelsfield.static intnarrayLayers(long struct) Unsafe version ofarrayLayers().static voidnarrayLayers(long struct, int value) Unsafe version ofarrayLayers.static VkExtent3Dnextent(long struct) Unsafe version ofextent().static voidnextent(long struct, VkExtent3D value) Unsafe version ofextent.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intnformat(long struct) Unsafe version offormat().static voidnformat(long struct, int value) Unsafe version offormat.static intnimageType(long struct) Unsafe version ofimageType().static voidnimageType(long struct, int value) Unsafe version ofimageType.static intninitialLayout(long struct) Unsafe version ofinitialLayout().static voidninitialLayout(long struct, int value) Unsafe version ofinitialLayout.static intnmipLevels(long struct) Unsafe version ofmipLevels().static voidnmipLevels(long struct, int value) Unsafe version ofmipLevels.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable IntBuffernpQueueFamilyIndices(long struct) Unsafe version ofpQueueFamilyIndices.static voidnpQueueFamilyIndices(long struct, @Nullable IntBuffer value) Unsafe version ofpQueueFamilyIndices.static intnqueueFamilyIndexCount(long struct) Unsafe version ofqueueFamilyIndexCount().static voidnqueueFamilyIndexCount(long struct, int value) Sets the specified value to thequeueFamilyIndexCountfield of the specifiedstruct.static intnsamples(long struct) Unsafe version ofsamples().static voidnsamples(long struct, int value) Unsafe version ofsamples.static intnsharingMode(long struct) Unsafe version ofsharingMode().static voidnsharingMode(long struct, int value) Unsafe version ofsharingMode.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntiling(long struct) Unsafe version oftiling().static voidntiling(long struct, int value) Unsafe version oftiling.static intnusage(long struct) Unsafe version ofusage().static voidnusage(long struct, int value) Unsafe version ofusage.longpNext()pNext(long value) Sets the specified value to thepNextfield.Prepends the specifiedVkDedicatedAllocationImageCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkExportMetalObjectCreateInfoEXTvalue to thepNextchain.pNext(VkExternalFormatANDROID value) Prepends the specifiedVkExternalFormatANDROIDvalue to thepNextchain.Prepends the specifiedVkExternalMemoryImageCreateInfovalue to thepNextchain.Prepends the specifiedVkExternalMemoryImageCreateInfoKHRvalue to thepNextchain.Prepends the specifiedVkExternalMemoryImageCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkImageAlignmentControlCreateInfoMESAvalue to thepNextchain.Prepends the specifiedVkImageCompressionControlEXTvalue to thepNextchain.Prepends the specifiedVkImageDrmFormatModifierExplicitCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkImageDrmFormatModifierListCreateInfoEXTvalue to thepNextchain.pNext(VkImageFormatListCreateInfo value) Prepends the specifiedVkImageFormatListCreateInfovalue to thepNextchain.Prepends the specifiedVkImageFormatListCreateInfoKHRvalue to thepNextchain.Prepends the specifiedVkImageStencilUsageCreateInfovalue to thepNextchain.Prepends the specifiedVkImageStencilUsageCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkImageSwapchainCreateInfoKHRvalue to thepNextchain.Prepends the specifiedVkImportMetalIOSurfaceInfoEXTvalue to thepNextchain.pNext(VkImportMetalTextureInfoEXT value) Prepends the specifiedVkImportMetalTextureInfoEXTvalue to thepNextchain.Prepends the specifiedVkOpaqueCaptureDescriptorDataCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkOpticalFlowImageFormatInfoNVvalue to thepNextchain.pNext(VkVideoProfileListInfoKHR value) Prepends the specifiedVkVideoProfileListInfoKHRvalue to thepNextchain.@Nullable IntBufferpQueueFamilyIndices(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepQueueFamilyIndicesfield.intqueueFamilyIndexCount(int value) Sets the specified value to thequeueFamilyIndexCountfield.intsamples()samples(int value) Sets the specified value to thesamplesfield.set(int sType, long pNext, int flags, int imageType, int format, VkExtent3D extent, int mipLevels, int arrayLayers, int samples, int tiling, int usage, int sharingMode, int queueFamilyIndexCount, @Nullable IntBuffer pQueueFamilyIndices, int initialLayout) Initializes this struct with the specified values.set(VkImageCreateInfo src) Copies the specified struct data to this struct.intsharingMode(int value) Sets the specified value to thesharingModefield.intsizeof()Returnssizeof(struct).intsType()sType(int value) Sets the specified value to thesTypefield.Sets theSTRUCTURE_TYPE_IMAGE_CREATE_INFOvalue to thesTypefield.inttiling()tiling(int value) Sets the specified value to thetilingfield.intusage()usage(int value) Sets the specified value to theusagefield.Methods 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. -
IMAGETYPE
public static final int IMAGETYPEThe struct member offsets. -
FORMAT
public static final int FORMATThe struct member offsets. -
EXTENT
public static final int EXTENTThe struct member offsets. -
MIPLEVELS
public static final int MIPLEVELSThe struct member offsets. -
ARRAYLAYERS
public static final int ARRAYLAYERSThe struct member offsets. -
SAMPLES
public static final int SAMPLESThe struct member offsets. -
TILING
public static final int TILINGThe struct member offsets. -
USAGE
public static final int USAGEThe struct member offsets. -
SHARINGMODE
public static final int SHARINGMODEThe struct member offsets. -
QUEUEFAMILYINDEXCOUNT
public static final int QUEUEFAMILYINDEXCOUNTThe struct member offsets. -
PQUEUEFAMILYINDICES
public static final int PQUEUEFAMILYINDICESThe struct member offsets. -
INITIALLAYOUT
public static final int INITIALLAYOUTThe struct member offsets.
-
-
Constructor Details
-
VkImageCreateInfo
Creates aVkImageCreateInfoinstance 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()Description copied from class:StructReturnssizeof(struct).- Specified by:
sizeofin classStruct<VkImageCreateInfo>
-
sType
public int sType()- Returns:
- the value of the
sTypefield.
-
pNext
public long pNext()- Returns:
- the value of the
pNextfield.
-
flags
public int flags()- Returns:
- the value of the
flagsfield.
-
imageType
public int imageType()- Returns:
- the value of the
imageTypefield.
-
format
public int format()- Returns:
- the value of the
formatfield.
-
extent
- Returns:
- a
VkExtent3Dview of theextentfield.
-
mipLevels
public int mipLevels()- Returns:
- the value of the
mipLevelsfield.
-
arrayLayers
public int arrayLayers()- Returns:
- the value of the
arrayLayersfield.
-
samples
public int samples()- Returns:
- the value of the
samplesfield.
-
tiling
public int tiling()- Returns:
- the value of the
tilingfield.
-
usage
public int usage()- Returns:
- the value of the
usagefield.
-
sharingMode
public int sharingMode()- Returns:
- the value of the
sharingModefield.
-
queueFamilyIndexCount
public int queueFamilyIndexCount()- Returns:
- the value of the
queueFamilyIndexCountfield.
-
pQueueFamilyIndices
- Returns:
- a
IntBufferview of the data pointed to by thepQueueFamilyIndicesfield.
-
initialLayout
public int initialLayout()- Returns:
- the value of the
initialLayoutfield.
-
sType
Sets the specified value to thesTypefield. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_CREATE_INFOvalue to thesTypefield. -
pNext
Sets the specified value to thepNextfield. -
pNext
Prepends the specifiedVkDedicatedAllocationImageCreateInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkExportMetalObjectCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalFormatANDROIDvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageAlignmentControlCreateInfoMESAvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageCompressionControlEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageDrmFormatModifierExplicitCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageDrmFormatModifierListCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageSwapchainCreateInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkImportMetalIOSurfaceInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImportMetalTextureInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkOpaqueCaptureDescriptorDataCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkOpticalFlowImageFormatInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoProfileListInfoKHRvalue to thepNextchain. -
flags
Sets the specified value to theflagsfield. -
imageType
Sets the specified value to theimageTypefield. -
format
Sets the specified value to theformatfield. -
extent
Copies the specifiedVkExtent3Dto theextentfield. -
extent
Passes theextentfield to the specifiedConsumer. -
mipLevels
Sets the specified value to themipLevelsfield. -
arrayLayers
Sets the specified value to thearrayLayersfield. -
samples
Sets the specified value to thesamplesfield. -
tiling
Sets the specified value to thetilingfield. -
usage
Sets the specified value to theusagefield. -
sharingMode
Sets the specified value to thesharingModefield. -
queueFamilyIndexCount
Sets the specified value to thequeueFamilyIndexCountfield. -
pQueueFamilyIndices
Sets the address of the specifiedIntBufferto thepQueueFamilyIndicesfield. -
initialLayout
Sets the specified value to theinitialLayoutfield. -
set
public VkImageCreateInfo set(int sType, long pNext, int flags, int imageType, int format, VkExtent3D extent, int mipLevels, int arrayLayers, int samples, int tiling, int usage, int sharingMode, int queueFamilyIndexCount, @Nullable IntBuffer pQueueFamilyIndices, int initialLayout) 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 newVkImageCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkImageCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageCreateInfo.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.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImageCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkImageCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkImageCreateInfo.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(). -
nimageType
public static int nimageType(long struct) Unsafe version ofimageType(). -
nformat
public static int nformat(long struct) Unsafe version offormat(). -
nextent
Unsafe version ofextent(). -
nmipLevels
public static int nmipLevels(long struct) Unsafe version ofmipLevels(). -
narrayLayers
public static int narrayLayers(long struct) Unsafe version ofarrayLayers(). -
nsamples
public static int nsamples(long struct) Unsafe version ofsamples(). -
ntiling
public static int ntiling(long struct) Unsafe version oftiling(). -
nusage
public static int nusage(long struct) Unsafe version ofusage(). -
nsharingMode
public static int nsharingMode(long struct) Unsafe version ofsharingMode(). -
nqueueFamilyIndexCount
public static int nqueueFamilyIndexCount(long struct) Unsafe version ofqueueFamilyIndexCount(). -
npQueueFamilyIndices
Unsafe version ofpQueueFamilyIndices. -
ninitialLayout
public static int ninitialLayout(long struct) Unsafe version ofinitialLayout(). -
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. -
nimageType
public static void nimageType(long struct, int value) Unsafe version ofimageType. -
nformat
public static void nformat(long struct, int value) Unsafe version offormat. -
nextent
Unsafe version ofextent. -
nmipLevels
public static void nmipLevels(long struct, int value) Unsafe version ofmipLevels. -
narrayLayers
public static void narrayLayers(long struct, int value) Unsafe version ofarrayLayers. -
nsamples
public static void nsamples(long struct, int value) Unsafe version ofsamples. -
ntiling
public static void ntiling(long struct, int value) Unsafe version oftiling. -
nusage
public static void nusage(long struct, int value) Unsafe version ofusage. -
nsharingMode
public static void nsharingMode(long struct, int value) Unsafe version ofsharingMode. -
nqueueFamilyIndexCount
public static void nqueueFamilyIndexCount(long struct, int value) Sets the specified value to thequeueFamilyIndexCountfield of the specifiedstruct. -
npQueueFamilyIndices
Unsafe version ofpQueueFamilyIndices. -
ninitialLayout
public static void ninitialLayout(long struct, int value) Unsafe version ofinitialLayout.
-