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.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The 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 aVkImageCreateInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
arrayLayers
(int value) Sets the specified value to thearrayLayers
field.static VkImageCreateInfo
calloc()
Returns a newVkImageCreateInfo
instance allocated withmemCalloc
.static VkImageCreateInfo.Buffer
calloc
(int capacity) Returns a newVkImageCreateInfo.Buffer
instance allocated withmemCalloc
.static VkImageCreateInfo.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageCreateInfo
calloc
(MemoryStack stack) Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageCreateInfo
Deprecated.static VkImageCreateInfo.Buffer
callocStack
(int capacity) Deprecated.static VkImageCreateInfo.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkImageCreateInfo
callocStack
(MemoryStack stack) Deprecated.static VkImageCreateInfo
create()
Returns a newVkImageCreateInfo
instance allocated withBufferUtils
.static VkImageCreateInfo.Buffer
create
(int capacity) Returns a newVkImageCreateInfo.Buffer
instance allocated withBufferUtils
.static VkImageCreateInfo
create
(long address) Returns a newVkImageCreateInfo
instance for the specified memory address.static VkImageCreateInfo.Buffer
create
(long address, int capacity) Create aVkImageCreateInfo.Buffer
instance at the specified memory.static @Nullable VkImageCreateInfo
createSafe
(long address) static @Nullable VkImageCreateInfo.Buffer
createSafe
(long address, int capacity) extent()
extent
(Consumer<VkExtent3D> consumer) Passes theextent
field to the specifiedConsumer
.extent
(VkExtent3D value) Copies the specifiedVkExtent3D
to theextent
field.int
flags()
flags
(int value) Sets the specified value to theflags
field.int
format()
format
(int value) Sets the specified value to theformat
field.int
imageType
(int value) Sets the specified value to theimageType
field.int
initialLayout
(int value) Sets the specified value to theinitialLayout
field.static VkImageCreateInfo
malloc()
Returns a newVkImageCreateInfo
instance allocated withmemAlloc
.static VkImageCreateInfo.Buffer
malloc
(int capacity) Returns a newVkImageCreateInfo.Buffer
instance allocated withmemAlloc
.static VkImageCreateInfo.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageCreateInfo
malloc
(MemoryStack stack) Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
.static VkImageCreateInfo
Deprecated.static VkImageCreateInfo.Buffer
mallocStack
(int capacity) Deprecated.static VkImageCreateInfo.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkImageCreateInfo
mallocStack
(MemoryStack stack) Deprecated.int
mipLevels
(int value) Sets the specified value to themipLevels
field.static int
narrayLayers
(long struct) Unsafe version ofarrayLayers()
.static void
narrayLayers
(long struct, int value) Unsafe version ofarrayLayers
.static VkExtent3D
nextent
(long struct) Unsafe version ofextent()
.static void
nextent
(long struct, VkExtent3D value) Unsafe version ofextent
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static int
nformat
(long struct) Unsafe version offormat()
.static void
nformat
(long struct, int value) Unsafe version offormat
.static int
nimageType
(long struct) Unsafe version ofimageType()
.static void
nimageType
(long struct, int value) Unsafe version ofimageType
.static int
ninitialLayout
(long struct) Unsafe version ofinitialLayout()
.static void
ninitialLayout
(long struct, int value) Unsafe version ofinitialLayout
.static int
nmipLevels
(long struct) Unsafe version ofmipLevels()
.static void
nmipLevels
(long struct, int value) Unsafe version ofmipLevels
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static @Nullable IntBuffer
npQueueFamilyIndices
(long struct) Unsafe version ofpQueueFamilyIndices
.static void
npQueueFamilyIndices
(long struct, @Nullable IntBuffer value) Unsafe version ofpQueueFamilyIndices
.static int
nqueueFamilyIndexCount
(long struct) Unsafe version ofqueueFamilyIndexCount()
.static void
nqueueFamilyIndexCount
(long struct, int value) Sets the specified value to thequeueFamilyIndexCount
field of the specifiedstruct
.static int
nsamples
(long struct) Unsafe version ofsamples()
.static void
nsamples
(long struct, int value) Unsafe version ofsamples
.static int
nsharingMode
(long struct) Unsafe version ofsharingMode()
.static void
nsharingMode
(long struct, int value) Unsafe version ofsharingMode
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
ntiling
(long struct) Unsafe version oftiling()
.static void
ntiling
(long struct, int value) Unsafe version oftiling
.static int
nusage
(long struct) Unsafe version ofusage()
.static void
nusage
(long struct, int value) Unsafe version ofusage
.long
pNext()
pNext
(long value) Sets the specified value to thepNext
field.Prepends the specifiedVkDedicatedAllocationImageCreateInfoNV
value to thepNext
chain.Prepends the specifiedVkExportMetalObjectCreateInfoEXT
value to thepNext
chain.pNext
(VkExternalFormatANDROID value) Prepends the specifiedVkExternalFormatANDROID
value to thepNext
chain.Prepends the specifiedVkExternalMemoryImageCreateInfo
value to thepNext
chain.Prepends the specifiedVkExternalMemoryImageCreateInfoKHR
value to thepNext
chain.Prepends the specifiedVkExternalMemoryImageCreateInfoNV
value to thepNext
chain.Prepends the specifiedVkImageAlignmentControlCreateInfoMESA
value to thepNext
chain.Prepends the specifiedVkImageCompressionControlEXT
value to thepNext
chain.Prepends the specifiedVkImageDrmFormatModifierExplicitCreateInfoEXT
value to thepNext
chain.Prepends the specifiedVkImageDrmFormatModifierListCreateInfoEXT
value to thepNext
chain.pNext
(VkImageFormatListCreateInfo value) Prepends the specifiedVkImageFormatListCreateInfo
value to thepNext
chain.Prepends the specifiedVkImageFormatListCreateInfoKHR
value to thepNext
chain.Prepends the specifiedVkImageStencilUsageCreateInfo
value to thepNext
chain.Prepends the specifiedVkImageStencilUsageCreateInfoEXT
value to thepNext
chain.Prepends the specifiedVkImageSwapchainCreateInfoKHR
value to thepNext
chain.Prepends the specifiedVkImportMetalIOSurfaceInfoEXT
value to thepNext
chain.pNext
(VkImportMetalTextureInfoEXT value) Prepends the specifiedVkImportMetalTextureInfoEXT
value to thepNext
chain.Prepends the specifiedVkOpaqueCaptureDescriptorDataCreateInfoEXT
value to thepNext
chain.Prepends the specifiedVkOpticalFlowImageFormatInfoNV
value to thepNext
chain.pNext
(VkVideoProfileListInfoKHR value) Prepends the specifiedVkVideoProfileListInfoKHR
value to thepNext
chain.@Nullable IntBuffer
pQueueFamilyIndices
(@Nullable IntBuffer value) Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices
field.int
queueFamilyIndexCount
(int value) Sets the specified value to thequeueFamilyIndexCount
field.int
samples()
samples
(int value) Sets the specified value to thesamples
field.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.int
sharingMode
(int value) Sets the specified value to thesharingMode
field.int
sizeof()
Returnssizeof(struct)
.int
sType()
sType
(int value) Sets the specified value to thesType
field.Sets theSTRUCTURE_TYPE_IMAGE_CREATE_INFO
value to thesType
field.int
tiling()
tiling
(int value) Sets the specified value to thetiling
field.int
usage()
usage
(int value) Sets the specified value to theusage
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkImageCreateInfo
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkImageCreateInfo>
-
sType
public int sType()- Returns:
- the value of the
sType
field.
-
pNext
public long pNext()- Returns:
- the value of the
pNext
field.
-
flags
public int flags()- Returns:
- the value of the
flags
field.
-
imageType
public int imageType()- Returns:
- the value of the
imageType
field.
-
format
public int format()- Returns:
- the value of the
format
field.
-
extent
- Returns:
- a
VkExtent3D
view of theextent
field.
-
mipLevels
public int mipLevels()- Returns:
- the value of the
mipLevels
field.
-
arrayLayers
public int arrayLayers()- Returns:
- the value of the
arrayLayers
field.
-
samples
public int samples()- Returns:
- the value of the
samples
field.
-
tiling
public int tiling()- Returns:
- the value of the
tiling
field.
-
usage
public int usage()- Returns:
- the value of the
usage
field.
-
sharingMode
public int sharingMode()- Returns:
- the value of the
sharingMode
field.
-
queueFamilyIndexCount
public int queueFamilyIndexCount()- Returns:
- the value of the
queueFamilyIndexCount
field.
-
pQueueFamilyIndices
- Returns:
- a
IntBuffer
view of the data pointed to by thepQueueFamilyIndices
field.
-
initialLayout
public int initialLayout()- Returns:
- the value of the
initialLayout
field.
-
sType
Sets the specified value to thesType
field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMAGE_CREATE_INFO
value to thesType
field. -
pNext
Sets the specified value to thepNext
field. -
pNext
Prepends the specifiedVkDedicatedAllocationImageCreateInfoNV
value to thepNext
chain. -
pNext
Prepends the specifiedVkExportMetalObjectCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkExternalFormatANDROID
value to thepNext
chain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkExternalMemoryImageCreateInfoNV
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageAlignmentControlCreateInfoMESA
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageCompressionControlEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageDrmFormatModifierExplicitCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageDrmFormatModifierListCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkImageSwapchainCreateInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkImportMetalIOSurfaceInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkImportMetalTextureInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkOpaqueCaptureDescriptorDataCreateInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkOpticalFlowImageFormatInfoNV
value to thepNext
chain. -
pNext
Prepends the specifiedVkVideoProfileListInfoKHR
value to thepNext
chain. -
flags
Sets the specified value to theflags
field. -
imageType
Sets the specified value to theimageType
field. -
format
Sets the specified value to theformat
field. -
extent
Copies the specifiedVkExtent3D
to theextent
field. -
extent
Passes theextent
field to the specifiedConsumer
. -
mipLevels
Sets the specified value to themipLevels
field. -
arrayLayers
Sets the specified value to thearrayLayers
field. -
samples
Sets the specified value to thesamples
field. -
tiling
Sets the specified value to thetiling
field. -
usage
Sets the specified value to theusage
field. -
sharingMode
Sets the specified value to thesharingMode
field. -
queueFamilyIndexCount
Sets the specified value to thequeueFamilyIndexCount
field. -
pQueueFamilyIndices
Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices
field. -
initialLayout
Sets the specified value to theinitialLayout
field. -
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 newVkImageCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkImageCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkImageCreateInfo
instance allocated withBufferUtils
. -
create
Returns a newVkImageCreateInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkImageCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkImageCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkImageCreateInfo.Buffer
instance 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 newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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 thequeueFamilyIndexCount
field of the specifiedstruct
. -
npQueueFamilyIndices
Unsafe version ofpQueueFamilyIndices
. -
ninitialLayout
public static void ninitialLayout(long struct, int value) Unsafe version ofinitialLayout
.
-