Package org.lwjgl.vulkan
Class VkImageViewUsageCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageViewUsageCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImageViewUsageCreateInfoKHR
public class VkImageViewUsageCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specify the intended usage of an image view.Description
When this structure is chained to
VkImageViewCreateInfo
theusage
field overrides the implicitusage
parameter inherited from image creation time and its value is used instead for the purposes of determining the valid usage conditions ofVkImageViewCreateInfo
.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO
usage
must be a valid combination ofVkImageUsageFlagBits
valuesusage
must not be 0
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.usage
– a bitmask describing the allowed usages of the image view. SeeVkImageUsageFlagBits
for a description of the supported bits.
Layout
struct VkImageViewUsageCreateInfo { VkStructureType sType; void const * pNext; VkImageUsageFlags usage; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImageViewUsageCreateInfo.Buffer
An array ofVkImageViewUsageCreateInfo
structs.
-
Constructor Summary
Constructors Constructor Description VkImageViewUsageCreateInfo(java.nio.ByteBuffer container)
Creates aVkImageViewUsageCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageViewUsageCreateInfo
calloc()
Returns a newVkImageViewUsageCreateInfo
instance allocated withmemCalloc
.static VkImageViewUsageCreateInfo.Buffer
calloc(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withmemCalloc
.static VkImageViewUsageCreateInfo
callocStack()
Returns a newVkImageViewUsageCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageViewUsageCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageViewUsageCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageViewUsageCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageViewUsageCreateInfo
create()
Returns a newVkImageViewUsageCreateInfo
instance allocated withBufferUtils
.static VkImageViewUsageCreateInfo.Buffer
create(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withBufferUtils
.static VkImageViewUsageCreateInfo
create(long address)
Returns a newVkImageViewUsageCreateInfo
instance for the specified memory address.static VkImageViewUsageCreateInfo.Buffer
create(long address, int capacity)
Create aVkImageViewUsageCreateInfo.Buffer
instance at the specified memory.static VkImageViewUsageCreateInfo
createSafe(long address)
static VkImageViewUsageCreateInfo.Buffer
createSafe(long address, int capacity)
static VkImageViewUsageCreateInfo
malloc()
Returns a newVkImageViewUsageCreateInfo
instance allocated withmemAlloc
.static VkImageViewUsageCreateInfo.Buffer
malloc(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withmemAlloc
.static VkImageViewUsageCreateInfo
mallocStack()
Returns a newVkImageViewUsageCreateInfo
instance allocated on the thread-localMemoryStack
.static VkImageViewUsageCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageViewUsageCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageViewUsageCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo
instance allocated on the specifiedMemoryStack
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nusage(long struct)
Unsafe version ofusage()
.static void
nusage(long struct, int value)
Unsafe version ofusage
.long
pNext()
Returns the value of thepNext
field.VkImageViewUsageCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkImageViewUsageCreateInfo
set(int sType, long pNext, int usage)
Initializes this struct with the specified values.VkImageViewUsageCreateInfo
set(VkImageViewUsageCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkImageViewUsageCreateInfo
sType(int value)
Sets the specified value to thesType
field.int
usage()
Returns the value of theusage
field.VkImageViewUsageCreateInfo
usage(int value)
Sets the specified value to theusage
field.
-
-
-
Constructor Detail
-
VkImageViewUsageCreateInfo
public VkImageViewUsageCreateInfo(java.nio.ByteBuffer container)
Creates aVkImageViewUsageCreateInfo
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()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
usage
public int usage()
Returns the value of theusage
field.
-
sType
public VkImageViewUsageCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImageViewUsageCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
usage
public VkImageViewUsageCreateInfo usage(int value)
Sets the specified value to theusage
field.
-
set
public VkImageViewUsageCreateInfo set(int sType, long pNext, int usage)
Initializes this struct with the specified values.
-
set
public VkImageViewUsageCreateInfo set(VkImageViewUsageCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageViewUsageCreateInfo malloc()
Returns a newVkImageViewUsageCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageViewUsageCreateInfo calloc()
Returns a newVkImageViewUsageCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageViewUsageCreateInfo create()
Returns a newVkImageViewUsageCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkImageViewUsageCreateInfo create(long address)
Returns a newVkImageViewUsageCreateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageViewUsageCreateInfo createSafe(long address)
-
malloc
public static VkImageViewUsageCreateInfo.Buffer malloc(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageViewUsageCreateInfo.Buffer calloc(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageViewUsageCreateInfo.Buffer create(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageViewUsageCreateInfo.Buffer create(long address, int capacity)
Create aVkImageViewUsageCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImageViewUsageCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageViewUsageCreateInfo mallocStack()
Returns a newVkImageViewUsageCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageViewUsageCreateInfo callocStack()
Returns a newVkImageViewUsageCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageViewUsageCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageViewUsageCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageViewUsageCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageViewUsageCreateInfo.Buffer callocStack(int capacity)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageViewUsageCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageViewUsageCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageViewUsageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nusage
public static int nusage(long struct)
Unsafe version ofusage()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nusage
public static void nusage(long struct, int value)
Unsafe version ofusage
.
-
-