Package org.lwjgl.vulkan
Class VkImageCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how an image should be created.
Valid Usage
sType
must beSTRUCTURE_TYPE_IMAGE_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkImageCreateFlagBits
valuesimageType
must be a validVkImageType
valueformat
must be a validVkFormat
valuesamples
must be a validVkSampleCountFlagBits
valuetiling
must be a validVkImageTiling
valueusage
must be a valid combination ofVkImageUsageFlagBits
valuesusage
must not be 0sharingMode
must be a validVkSharingMode
valueinitialLayout
must be a validVkImageLayout
value- If
sharingMode
isSHARING_MODE_CONCURRENT
,pQueueFamilyIndices
must be a pointer to an array ofqueueFamilyIndexCount
uint32_t
values - If
sharingMode
isSHARING_MODE_CONCURRENT
,queueFamilyIndexCount
must be greater than 1 format
must not beFORMAT_UNDEFINED
- The
width
,height
, anddepth
members ofextent
must all be greater than 0 mipLevels
must be greater than 0arrayLayers
must be greater than 0- If
imageType
isIMAGE_TYPE_1D
,extent.width
must be less than or equal toVkPhysicalDeviceLimits
::maxImageDimension1D
, orVkImageFormatProperties
::maxExtent
.width (as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) - whichever is higher - If
imageType
isIMAGE_TYPE_2D
andflags
does not containIMAGE_CREATE_CUBE_COMPATIBLE_BIT
,extent.width
andextent.height
must be less than or equal toVkPhysicalDeviceLimits
::maxImageDimension2D
, orVkImageFormatProperties
::maxExtent
.width/height (as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) - whichever is higher - If
imageType
isIMAGE_TYPE_2D
andflags
containsIMAGE_CREATE_CUBE_COMPATIBLE_BIT
,extent.width
andextent.height
must be less than or equal toVkPhysicalDeviceLimits
::maxImageDimensionCube
, orVkImageFormatProperties
::maxExtent
.width/height (as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) - whichever is higher - If
imageType
isIMAGE_TYPE_2D
andflags
containsIMAGE_CREATE_CUBE_COMPATIBLE_BIT
,extent.width
andextent.height
must be equal - If
imageType
isIMAGE_TYPE_3D
,extent.width
,extent.height
andextent.depth
must be less than or equal toVkPhysicalDeviceLimits
::maxImageDimension3D
, orVkImageFormatProperties
::maxExtent
.width/height/depth (as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) - whichever is higher - If
imageType
isIMAGE_TYPE_1D
, bothextent.height
andextent.depth
must be 1 - If
imageType
isIMAGE_TYPE_2D
,extent.depth
must be 1 mipLevels
must be less than or equal tofloor(log2(max(extent.width, extent.height, extent.depth))) + 1
- If any of
extent.width
,extent.height
orextent.depth
are greater than the equivalently named members ofVkPhysicalDeviceLimits
::maxImageDimension3D
,mipLevels
must be less than or equal toVkImageFormatProperties
::maxMipLevels
(as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) arrayLayers
must be less than or equal toVkPhysicalDeviceLimits
::maxImageArrayLayers
, orVkImageFormatProperties
::maxArrayLayers
(as returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure) - whichever is highersamples
must be a bit value that is set inVkPhysicalDeviceLimits
::sampleCounts
returned byGetPhysicalDeviceProperties
, orVkImageFormatProperties
::sampleCounts
returned byGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
,usage
andflags
equal to those in this structure- If
usage
includesIMAGE_USAGE_COLOR_ATTACHMENT_BIT
,IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
,IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
,extent.width
must be less than or equal toVkPhysicalDeviceLimits
::maxFramebufferWidth
- If
usage
includesIMAGE_USAGE_COLOR_ATTACHMENT_BIT
,IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
,IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
orIMAGE_USAGE_INPUT_ATTACHMENT_BIT
,extent.height
must be less than or equal toVkPhysicalDeviceLimits
::maxFramebufferHeight
- If
usage
includesIMAGE_USAGE_COLOR_ATTACHMENT_BIT
,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::framebufferColorSampleCounts
- If
usage
includesIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
, andformat
includes a depth aspect,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::framebufferDepthSampleCounts
- If
usage
includesIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
, andformat
includes a stencil aspect,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::framebufferStencilSampleCounts
- If
usage
includesIMAGE_USAGE_SAMPLED_BIT
, andformat
includes a color aspect,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::sampledImageColorSampleCounts
- If
usage
includesIMAGE_USAGE_SAMPLED_BIT
, andformat
includes a depth aspect,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::sampledImageDepthSampleCounts
- If
usage
includesIMAGE_USAGE_SAMPLED_BIT
, andformat
is an integer format,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::sampledImageIntegerSampleCounts
- If
usage
includesIMAGE_USAGE_STORAGE_BIT
,samples
must be a bit value that is set inVkPhysicalDeviceLimits
::storageImageSampleCounts
- If the ETC2 texture compression feature is not enabled,
format
must not beFORMAT_ETC2_R8G8B8_UNORM_BLOCK
,FORMAT_ETC2_R8G8B8_SRGB_BLOCK
,FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK
,FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK
,FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK
,FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK
,FORMAT_EAC_R11_UNORM_BLOCK
,FORMAT_EAC_R11_SNORM_BLOCK
,FORMAT_EAC_R11G11_UNORM_BLOCK
, orFORMAT_EAC_R11G11_SNORM_BLOCK
- If the ASTC LDR texture compression feature is not enabled,
format
must not beFORMAT_ASTC_4x4_UNORM_BLOCK
,FORMAT_ASTC_4x4_SRGB_BLOCK
,FORMAT_ASTC_5x4_UNORM_BLOCK
,FORMAT_ASTC_5x4_SRGB_BLOCK
,FORMAT_ASTC_5x5_UNORM_BLOCK
,FORMAT_ASTC_5x5_SRGB_BLOCK
,FORMAT_ASTC_6x5_UNORM_BLOCK
,FORMAT_ASTC_6x5_SRGB_BLOCK
,FORMAT_ASTC_6x6_UNORM_BLOCK
,FORMAT_ASTC_6x6_SRGB_BLOCK
,FORMAT_ASTC_8x5_UNORM_BLOCK
,FORMAT_ASTC_8x5_SRGB_BLOCK
,FORMAT_ASTC_8x6_UNORM_BLOCK
,FORMAT_ASTC_8x6_SRGB_BLOCK
,FORMAT_ASTC_8x8_UNORM_BLOCK
,FORMAT_ASTC_8x8_SRGB_BLOCK
,FORMAT_ASTC_10x5_UNORM_BLOCK
,FORMAT_ASTC_10x5_SRGB_BLOCK
,FORMAT_ASTC_10x6_UNORM_BLOCK
,FORMAT_ASTC_10x6_SRGB_BLOCK
,FORMAT_ASTC_10x8_UNORM_BLOCK
,FORMAT_ASTC_10x8_SRGB_BLOCK
,FORMAT_ASTC_10x10_UNORM_BLOCK
,FORMAT_ASTC_10x10_SRGB_BLOCK
,FORMAT_ASTC_12x10_UNORM_BLOCK
,FORMAT_ASTC_12x10_SRGB_BLOCK
,FORMAT_ASTC_12x12_UNORM_BLOCK
, orFORMAT_ASTC_12x12_SRGB_BLOCK
- If the BC texture compression feature is not enabled,
format
must not beFORMAT_BC1_RGB_UNORM_BLOCK
,FORMAT_BC1_RGB_SRGB_BLOCK
,FORMAT_BC1_RGBA_UNORM_BLOCK
,FORMAT_BC1_RGBA_SRGB_BLOCK
,FORMAT_BC2_UNORM_BLOCK
,FORMAT_BC2_SRGB_BLOCK
,FORMAT_BC3_UNORM_BLOCK
,FORMAT_BC3_SRGB_BLOCK
,FORMAT_BC4_UNORM_BLOCK
,FORMAT_BC4_SNORM_BLOCK
,FORMAT_BC5_UNORM_BLOCK
,FORMAT_BC5_SNORM_BLOCK
,FORMAT_BC6H_UFLOAT_BLOCK
,FORMAT_BC6H_SFLOAT_BLOCK
,FORMAT_BC7_UNORM_BLOCK
, orFORMAT_BC7_SRGB_BLOCK
- If the multisampled storage images feature is not enabled, and
usage
containsIMAGE_USAGE_STORAGE_BIT
,samples
must beSAMPLE_COUNT_1_BIT
- If the sparse bindings feature is not enabled,
flags
must not containIMAGE_CREATE_SPARSE_BINDING_BIT
- If the sparse residency for 2D images feature is not enabled, and
imageType
isIMAGE_TYPE_2D
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse residency for 3D images feature is not enabled, and
imageType
isIMAGE_TYPE_3D
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse residency for images with 2 samples feature is not enabled,
imageType
isIMAGE_TYPE_2D
, andsamples
isSAMPLE_COUNT_2_BIT
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse residency for images with 4 samples feature is not enabled,
imageType
isIMAGE_TYPE_2D
, andsamples
isSAMPLE_COUNT_4_BIT
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse residency for images with 8 samples feature is not enabled,
imageType
isIMAGE_TYPE_2D
, andsamples
isSAMPLE_COUNT_8_BIT
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If the sparse residency for images with 16 samples feature is not enabled,
imageType
isIMAGE_TYPE_2D
, andsamples
isSAMPLE_COUNT_16_BIT
,flags
must not containIMAGE_CREATE_SPARSE_RESIDENCY_BIT
- If
tiling
isIMAGE_TILING_LINEAR
, andVkFormatProperties
::linearTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_SAMPLED_IMAGE_BIT
,usage
must not containIMAGE_USAGE_SAMPLED_BIT
- If
tiling
isIMAGE_TILING_LINEAR
, andVkFormatProperties
::linearTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_STORAGE_IMAGE_BIT
,usage
must not containIMAGE_USAGE_STORAGE_BIT
- If
tiling
isIMAGE_TILING_LINEAR
, andVkFormatProperties
::linearTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_COLOR_ATTACHMENT_BIT
,usage
must not containIMAGE_USAGE_COLOR_ATTACHMENT_BIT
- If
tiling
isIMAGE_TILING_LINEAR
, andVkFormatProperties
::linearTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
,usage
must not containIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
tiling
isIMAGE_TILING_OPTIMAL
, andVkFormatProperties
::optimalTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_SAMPLED_IMAGE_BIT
,usage
must not containIMAGE_USAGE_SAMPLED_BIT
- If
tiling
isIMAGE_TILING_OPTIMAL
, andVkFormatProperties
::optimalTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_STORAGE_IMAGE_BIT
,usage
must not containIMAGE_USAGE_STORAGE_BIT
- If
tiling
isIMAGE_TILING_OPTIMAL
, andVkFormatProperties
::optimalTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_COLOR_ATTACHMENT_BIT
,usage
must not containIMAGE_USAGE_COLOR_ATTACHMENT_BIT
- If
tiling
isIMAGE_TILING_OPTIMAL
, andVkFormatProperties
::optimalTilingFeatures
(as returned byGetPhysicalDeviceFormatProperties
with the same value offormat
) does not includeFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
,usage
must not containIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
flags
containsIMAGE_CREATE_SPARSE_RESIDENCY_BIT
orIMAGE_CREATE_SPARSE_ALIASED_BIT
, it must also containIMAGE_CREATE_SPARSE_BINDING_BIT
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_IMAGE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– aVkImageCreateFlagBits
bitfield describing additional parameters of the image. One or more of:IMAGE_CREATE_CUBE_COMPATIBLE_BIT
IMAGE_CREATE_MUTABLE_FORMAT_BIT
IMAGE_CREATE_SPARSE_ALIASED_BIT
IMAGE_CREATE_SPARSE_BINDING_BIT
IMAGE_CREATE_SPARSE_RESIDENCY_BIT
imageType
– the basic dimensionality of the image. One of:IMAGE_TYPE_1D
IMAGE_TYPE_2D
IMAGE_TYPE_3D
format
– aVkFormat
describing the format and type of the data elements that will be contained in the imageextent
– aVkExtent3D
describing the number of data elements in each dimension of the base levelmipLevels
– the number of levels of detail available for minified sampling of the imagearrayLayers
– the number of layers in the imagesamples
– the number of sub-data element samples in the image as defined inVkSampleCountFlagBits
. One or more of:SAMPLE_COUNT_16_BIT
SAMPLE_COUNT_1_BIT
SAMPLE_COUNT_2_BIT
SAMPLE_COUNT_32_BIT
SAMPLE_COUNT_4_BIT
SAMPLE_COUNT_64_BIT
SAMPLE_COUNT_8_BIT
tiling
– the tiling arrangement of the data elements in memory. One of:IMAGE_TILING_LINEAR
IMAGE_TILING_OPTIMAL
usage
– a bitfield describing the intended usage of the image. One or more of:sharingMode
– the sharing mode of the image when it will be accessed by multiple queue families. One of:SHARING_MODE_CONCURRENT
SHARING_MODE_EXCLUSIVE
queueFamilyIndexCount
– the number of entries in thepQueueFamilyIndices
arraypQueueFamilyIndices
– a list of queue families that will access this image (ignored ifsharingMode
is notSHARING_MODE_CONCURRENT
)initialLayout
– selects the initialVkImageLayout
state of all image subresources of the image. One of:
Layout
struct VkImageCreateInfo { VkStructureType sType; const void * pNext; VkImageCreateFlags flags; VkImageType imageType; VkFormat format;
VkExtent3D
extent; uint32_t mipLevels; uint32_t arrayLayers; VkSampleCountFlagBits samples; VkImageTiling tiling; VkImageUsageFlags usage; VkSharingMode sharingMode; uint32_t queueFamilyIndexCount; const uint32_t * pQueueFamilyIndices; VkImageLayout initialLayout; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkImageCreateInfo.Buffer
An array ofVkImageCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkImageCreateInfo(java.nio.ByteBuffer container)
Creates aVkImageCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
arrayLayers()
Returns the value of thearrayLayers
field.VkImageCreateInfo
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
callocStack()
Returns a newVkImageCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageCreateInfo
callocStack(MemoryStack stack)
Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.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 ornull
if the address isNULL
.static VkImageCreateInfo.Buffer
create(long address, int capacity)
Create aVkImageCreateInfo.Buffer
instance at the specified memory.VkExtent3D
extent()
Returns aVkExtent3D
view of theextent
field.VkImageCreateInfo
extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.int
flags()
Returns the value of theflags
field.VkImageCreateInfo
flags(int value)
Sets the specified value to theflags
field.int
format()
Returns the value of theformat
field.VkImageCreateInfo
format(int value)
Sets the specified value to theformat
field.int
imageType()
Returns the value of theimageType
field.VkImageCreateInfo
imageType(int value)
Sets the specified value to theimageType
field.int
initialLayout()
Returns the value of theinitialLayout
field.VkImageCreateInfo
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
mallocStack()
Returns a newVkImageCreateInfo
instance allocated on the thread-localMemoryStack
.static VkImageCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
.int
mipLevels()
Returns the value of themipLevels
field.VkImageCreateInfo
mipLevels(int value)
Sets the specified value to themipLevels
field.VkImageCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkImageCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.java.nio.IntBuffer
pQueueFamilyIndices()
Returns aIntBuffer
view of the data pointed to by thepQueueFamilyIndices
field.VkImageCreateInfo
pQueueFamilyIndices(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices
field.int
queueFamilyIndexCount()
Returns the value of thequeueFamilyIndexCount
field.int
samples()
Returns the value of thesamples
field.VkImageCreateInfo
samples(int value)
Sets the specified value to thesamples
field.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, java.nio.IntBuffer pQueueFamilyIndices, int initialLayout)
Initializes this struct with the specified values.VkImageCreateInfo
set(VkImageCreateInfo src)
Copies the specified struct data to this struct.int
sharingMode()
Returns the value of thesharingMode
field.VkImageCreateInfo
sharingMode(int value)
Sets the specified value to thesharingMode
field.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkImageCreateInfo
sType(int value)
Sets the specified value to thesType
field.int
tiling()
Returns the value of thetiling
field.VkImageCreateInfo
tiling(int value)
Sets the specified value to thetiling
field.int
usage()
Returns the value of theusage
field.VkImageCreateInfo
usage(int value)
Sets the specified value to theusage
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
CallsVkImageCreateInfo.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
-
VkImageCreateInfo
public VkImageCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
imageType
public int imageType()
Returns the value of theimageType
field.
-
format
public int format()
Returns the value of theformat
field.
-
extent
public VkExtent3D extent()
Returns aVkExtent3D
view of theextent
field.
-
mipLevels
public int mipLevels()
Returns the value of themipLevels
field.
-
arrayLayers
public int arrayLayers()
Returns the value of thearrayLayers
field.
-
samples
public int samples()
Returns the value of thesamples
field.
-
tiling
public int tiling()
Returns the value of thetiling
field.
-
usage
public int usage()
Returns the value of theusage
field.
-
sharingMode
public int sharingMode()
Returns the value of thesharingMode
field.
-
queueFamilyIndexCount
public int queueFamilyIndexCount()
Returns the value of thequeueFamilyIndexCount
field.
-
pQueueFamilyIndices
public java.nio.IntBuffer pQueueFamilyIndices()
Returns aIntBuffer
view of the data pointed to by thepQueueFamilyIndices
field.
-
initialLayout
public int initialLayout()
Returns the value of theinitialLayout
field.
-
sType
public VkImageCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImageCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkImageCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
imageType
public VkImageCreateInfo imageType(int value)
Sets the specified value to theimageType
field.
-
format
public VkImageCreateInfo format(int value)
Sets the specified value to theformat
field.
-
extent
public VkImageCreateInfo extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.
-
mipLevels
public VkImageCreateInfo mipLevels(int value)
Sets the specified value to themipLevels
field.
-
arrayLayers
public VkImageCreateInfo arrayLayers(int value)
Sets the specified value to thearrayLayers
field.
-
samples
public VkImageCreateInfo samples(int value)
Sets the specified value to thesamples
field.
-
tiling
public VkImageCreateInfo tiling(int value)
Sets the specified value to thetiling
field.
-
usage
public VkImageCreateInfo usage(int value)
Sets the specified value to theusage
field.
-
sharingMode
public VkImageCreateInfo sharingMode(int value)
Sets the specified value to thesharingMode
field.
-
pQueueFamilyIndices
public VkImageCreateInfo pQueueFamilyIndices(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepQueueFamilyIndices
field.
-
initialLayout
public VkImageCreateInfo initialLayout(int value)
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, java.nio.IntBuffer pQueueFamilyIndices, int initialLayout)
Initializes this struct with the specified values.
-
nset
public VkImageCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkImageCreateInfo set(VkImageCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageCreateInfo malloc()
Returns a newVkImageCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageCreateInfo calloc()
Returns a newVkImageCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageCreateInfo create()
Returns a newVkImageCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkImageCreateInfo create(long address)
Returns a newVkImageCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkImageCreateInfo.Buffer malloc(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageCreateInfo.Buffer calloc(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageCreateInfo.Buffer create(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageCreateInfo.Buffer create(long address, int capacity)
Create aVkImageCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkImageCreateInfo mallocStack()
Returns a newVkImageCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageCreateInfo callocStack()
Returns a newVkImageCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageCreateInfo mallocStack(MemoryStack stack)
Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageCreateInfo callocStack(MemoryStack stack)
Returns a newVkImageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageCreateInfo.Buffer callocStack(int capacity)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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)
CallsVkImageCreateInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-