Package org.lwjgl.vulkan
Class VkDescriptorImageInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorImageInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDescriptorImageInfo extends Struct
Khronos Reference Page
Vulkan SpecificationValid Usage
- Each of
sampler
andimageView
that are valid handles must have been created, allocated or retrieved from the sameVkDevice
Member documentation
sampler
– a sampler handle, and is used in descriptor updates for typesDESCRIPTOR_TYPE_SAMPLER
andDESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
if the binding being updated does not use immutable samplersimageView
– an image view handle, and is used in descriptor updates for typesDESCRIPTOR_TYPE_SAMPLED_IMAGE
,DESCRIPTOR_TYPE_STORAGE_IMAGE
,DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
, andDESCRIPTOR_TYPE_INPUT_ATTACHMENT
imageLayout
– the layout that the image will be in at the time this descriptor is accessed.imageLayout
is used in descriptor updates for typesDESCRIPTOR_TYPE_SAMPLED_IMAGE
,DESCRIPTOR_TYPE_STORAGE_IMAGE
,DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
, andDESCRIPTOR_TYPE_INPUT_ATTACHMENT
. One of:
Layout
struct VkDescriptorImageInfo { VkSampler sampler; VkImageView imageView; VkImageLayout imageLayout; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkDescriptorImageInfo.Buffer
An array ofVkDescriptorImageInfo
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 VkDescriptorImageInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorImageInfo
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 static VkDescriptorImageInfo
calloc()
Returns a newVkDescriptorImageInfo
instance allocated withmemCalloc
.static VkDescriptorImageInfo.Buffer
calloc(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withmemCalloc
.static VkDescriptorImageInfo
callocStack()
Returns a newVkDescriptorImageInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorImageInfo.Buffer
callocStack(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorImageInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorImageInfo
callocStack(MemoryStack stack)
Returns a newVkDescriptorImageInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorImageInfo
create()
Returns a newVkDescriptorImageInfo
instance allocated withBufferUtils
.static VkDescriptorImageInfo.Buffer
create(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withBufferUtils
.static VkDescriptorImageInfo
create(long address)
Returns a newVkDescriptorImageInfo
instance for the specified memory address ornull
if the address isNULL
.static VkDescriptorImageInfo.Buffer
create(long address, int capacity)
Create aVkDescriptorImageInfo.Buffer
instance at the specified memory.int
imageLayout()
Returns the value of theimageLayout
field.VkDescriptorImageInfo
imageLayout(int value)
Sets the specified value to theimageLayout
field.long
imageView()
Returns the value of theimageView
field.VkDescriptorImageInfo
imageView(long value)
Sets the specified value to theimageView
field.static VkDescriptorImageInfo
malloc()
Returns a newVkDescriptorImageInfo
instance allocated withmemAlloc
.static VkDescriptorImageInfo.Buffer
malloc(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withmemAlloc
.static VkDescriptorImageInfo
mallocStack()
Returns a newVkDescriptorImageInfo
instance allocated on the thread-localMemoryStack
.static VkDescriptorImageInfo.Buffer
mallocStack(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkDescriptorImageInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDescriptorImageInfo
mallocStack(MemoryStack stack)
Returns a newVkDescriptorImageInfo
instance allocated on the specifiedMemoryStack
.VkDescriptorImageInfo
nset(long struct)
Unsafe version ofset
.long
sampler()
Returns the value of thesampler
field.VkDescriptorImageInfo
sampler(long value)
Sets the specified value to thesampler
field.VkDescriptorImageInfo
set(long sampler, long imageView, int imageLayout)
Initializes this struct with the specified values.VkDescriptorImageInfo
set(VkDescriptorImageInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkDescriptorImageInfo
public VkDescriptorImageInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorImageInfo
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)
.
-
sampler
public long sampler()
Returns the value of thesampler
field.
-
imageView
public long imageView()
Returns the value of theimageView
field.
-
imageLayout
public int imageLayout()
Returns the value of theimageLayout
field.
-
sampler
public VkDescriptorImageInfo sampler(long value)
Sets the specified value to thesampler
field.
-
imageView
public VkDescriptorImageInfo imageView(long value)
Sets the specified value to theimageView
field.
-
imageLayout
public VkDescriptorImageInfo imageLayout(int value)
Sets the specified value to theimageLayout
field.
-
set
public VkDescriptorImageInfo set(long sampler, long imageView, int imageLayout)
Initializes this struct with the specified values.
-
nset
public VkDescriptorImageInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkDescriptorImageInfo set(VkDescriptorImageInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorImageInfo malloc()
Returns a newVkDescriptorImageInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDescriptorImageInfo calloc()
Returns a newVkDescriptorImageInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDescriptorImageInfo create()
Returns a newVkDescriptorImageInfo
instance allocated withBufferUtils
.
-
create
public static VkDescriptorImageInfo create(long address)
Returns a newVkDescriptorImageInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDescriptorImageInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDescriptorImageInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorImageInfo.Buffer create(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorImageInfo.Buffer create(long address, int capacity)
Create aVkDescriptorImageInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDescriptorImageInfo mallocStack()
Returns a newVkDescriptorImageInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDescriptorImageInfo callocStack()
Returns a newVkDescriptorImageInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDescriptorImageInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorImageInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDescriptorImageInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorImageInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDescriptorImageInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDescriptorImageInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorImageInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-