Package org.lwjgl.vulkan
Class VkFramebufferAttachmentImageInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkFramebufferAttachmentImageInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkFramebufferAttachmentImageInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters of an image that will be used with a framebuffer.Description
Images that can be used with the framebuffer when beginning a render pass, as specified by
VkRenderPassAttachmentBeginInfoKHR
, must be created with parameters that are identical to those specified here.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO_KHR
pNext
must beNULL
flags
must be a valid combination ofVkImageCreateFlagBits
valuesusage
must be a valid combination ofVkImageUsageFlagBits
valuesusage
must not be 0- If
viewFormatCount
is not 0,pViewFormats
must be a valid pointer to an array ofviewFormatCount
validVkFormat
values
See Also
VkFramebufferAttachmentsCreateInfoKHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– a bitmask ofVkImageCreateFlagBits
, matching the value ofVkImageCreateInfo
::flags
used to create an image that will be used with this framebuffer.usage
– a bitmask ofVkImageUsageFlagBits
, matching the value ofVkImageCreateInfo
::usage
used to create an image used with this framebuffer.width
– the width of the image view used for rendering.height
– the height of the image view used for rendering.viewFormatCount
– the number of entries in thepViewFormats
array, matching the value ofVkImageFormatListCreateInfoKHR
::viewFormatCount
used to create an image used with this framebuffer.pViewFormats
– an array which lists of all formats which can be used when creating views of the image, matching the value ofVkImageFormatListCreateInfoKHR
::pViewFormats used to create an image used with this framebuffer.
Layout
struct VkFramebufferAttachmentImageInfoKHR { VkStructureType sType; void const * pNext; VkImageCreateFlags flags; VkImageUsageFlags usage; uint32_t width; uint32_t height; uint32_t layerCount; uint32_t viewFormatCount; VkFormat const * pViewFormats; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkFramebufferAttachmentImageInfoKHR.Buffer
An array ofVkFramebufferAttachmentImageInfoKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
HEIGHT
LAYERCOUNT
PNEXT
PVIEWFORMATSThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
USAGE
VIEWFORMATCOUNT
WIDTHThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)
Creates aVkFramebufferAttachmentImageInfoKHR
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 VkFramebufferAttachmentImageInfoKHR
calloc()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withmemCalloc
.static VkFramebufferAttachmentImageInfoKHR.Buffer
calloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withmemCalloc
.static VkFramebufferAttachmentImageInfoKHR
callocStack()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR
create()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withBufferUtils
.static VkFramebufferAttachmentImageInfoKHR.Buffer
create(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withBufferUtils
.static VkFramebufferAttachmentImageInfoKHR
create(long address)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance for the specified memory address.static VkFramebufferAttachmentImageInfoKHR.Buffer
create(long address, int capacity)
Create aVkFramebufferAttachmentImageInfoKHR.Buffer
instance at the specified memory.static VkFramebufferAttachmentImageInfoKHR
createSafe(long address)
static VkFramebufferAttachmentImageInfoKHR.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkFramebufferAttachmentImageInfoKHR
flags(int value)
Sets the specified value to theflags
field.int
height()
Returns the value of theheight
field.VkFramebufferAttachmentImageInfoKHR
height(int value)
Sets the specified value to theheight
field.int
layerCount()
Returns the value of thelayerCount
field.VkFramebufferAttachmentImageInfoKHR
layerCount(int value)
Sets the specified value to thelayerCount
field.static VkFramebufferAttachmentImageInfoKHR
malloc()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withmemAlloc
.static VkFramebufferAttachmentImageInfoKHR.Buffer
malloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withmemAlloc
.static VkFramebufferAttachmentImageInfoKHR
mallocStack()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the thread-localMemoryStack
.static VkFramebufferAttachmentImageInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkFramebufferAttachmentImageInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkFramebufferAttachmentImageInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
nheight(long struct)
Unsafe version ofheight()
.static void
nheight(long struct, int value)
Unsafe version ofheight
.static int
nlayerCount(long struct)
Unsafe version oflayerCount()
.static void
nlayerCount(long struct, int value)
Unsafe version oflayerCount
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.IntBuffer
npViewFormats(long struct)
Unsafe version ofpViewFormats
.static void
npViewFormats(long struct, java.nio.IntBuffer value)
Unsafe version ofpViewFormats
.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
.static int
nviewFormatCount(long struct)
Unsafe version ofviewFormatCount()
.static void
nviewFormatCount(long struct, int value)
Sets the specified value to theviewFormatCount
field of the specifiedstruct
.static int
nwidth(long struct)
Unsafe version ofwidth()
.static void
nwidth(long struct, int value)
Unsafe version ofwidth
.long
pNext()
Returns the value of thepNext
field.VkFramebufferAttachmentImageInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.java.nio.IntBuffer
pViewFormats()
Returns aIntBuffer
view of the data pointed to by thepViewFormats
field.VkFramebufferAttachmentImageInfoKHR
pViewFormats(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepViewFormats
field.VkFramebufferAttachmentImageInfoKHR
set(int sType, long pNext, int flags, int usage, int width, int height, int layerCount, java.nio.IntBuffer pViewFormats)
Initializes this struct with the specified values.VkFramebufferAttachmentImageInfoKHR
set(VkFramebufferAttachmentImageInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkFramebufferAttachmentImageInfoKHR
sType(int value)
Sets the specified value to thesType
field.int
usage()
Returns the value of theusage
field.VkFramebufferAttachmentImageInfoKHR
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)
Callsvalidate(long)
for each struct contained in the specified struct array.int
viewFormatCount()
Returns the value of theviewFormatCount
field.int
width()
Returns the value of thewidth
field.VkFramebufferAttachmentImageInfoKHR
width(int value)
Sets the specified value to thewidth
field.
-
-
-
Constructor Detail
-
VkFramebufferAttachmentImageInfoKHR
public VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)
Creates aVkFramebufferAttachmentImageInfoKHR
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.
-
flags
public int flags()
Returns the value of theflags
field.
-
usage
public int usage()
Returns the value of theusage
field.
-
width
public int width()
Returns the value of thewidth
field.
-
height
public int height()
Returns the value of theheight
field.
-
layerCount
public int layerCount()
Returns the value of thelayerCount
field.
-
viewFormatCount
public int viewFormatCount()
Returns the value of theviewFormatCount
field.
-
pViewFormats
@Nullable public java.nio.IntBuffer pViewFormats()
Returns aIntBuffer
view of the data pointed to by thepViewFormats
field.
-
sType
public VkFramebufferAttachmentImageInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkFramebufferAttachmentImageInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkFramebufferAttachmentImageInfoKHR flags(int value)
Sets the specified value to theflags
field.
-
usage
public VkFramebufferAttachmentImageInfoKHR usage(int value)
Sets the specified value to theusage
field.
-
width
public VkFramebufferAttachmentImageInfoKHR width(int value)
Sets the specified value to thewidth
field.
-
height
public VkFramebufferAttachmentImageInfoKHR height(int value)
Sets the specified value to theheight
field.
-
layerCount
public VkFramebufferAttachmentImageInfoKHR layerCount(int value)
Sets the specified value to thelayerCount
field.
-
pViewFormats
public VkFramebufferAttachmentImageInfoKHR pViewFormats(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepViewFormats
field.
-
set
public VkFramebufferAttachmentImageInfoKHR set(int sType, long pNext, int flags, int usage, int width, int height, int layerCount, @Nullable java.nio.IntBuffer pViewFormats)
Initializes this struct with the specified values.
-
set
public VkFramebufferAttachmentImageInfoKHR set(VkFramebufferAttachmentImageInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkFramebufferAttachmentImageInfoKHR malloc()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkFramebufferAttachmentImageInfoKHR calloc()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkFramebufferAttachmentImageInfoKHR create()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkFramebufferAttachmentImageInfoKHR create(long address)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkFramebufferAttachmentImageInfoKHR createSafe(long address)
-
malloc
public static VkFramebufferAttachmentImageInfoKHR.Buffer malloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkFramebufferAttachmentImageInfoKHR.Buffer calloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(long address, int capacity)
Create aVkFramebufferAttachmentImageInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkFramebufferAttachmentImageInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkFramebufferAttachmentImageInfoKHR mallocStack()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR callocStack()
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkFramebufferAttachmentImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHR.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()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
nusage
public static int nusage(long struct)
Unsafe version ofusage()
.
-
nwidth
public static int nwidth(long struct)
Unsafe version ofwidth()
.
-
nheight
public static int nheight(long struct)
Unsafe version ofheight()
.
-
nlayerCount
public static int nlayerCount(long struct)
Unsafe version oflayerCount()
.
-
nviewFormatCount
public static int nviewFormatCount(long struct)
Unsafe version ofviewFormatCount()
.
-
npViewFormats
@Nullable public static java.nio.IntBuffer npViewFormats(long struct)
Unsafe version ofpViewFormats
.
-
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
.
-
nusage
public static void nusage(long struct, int value)
Unsafe version ofusage
.
-
nwidth
public static void nwidth(long struct, int value)
Unsafe version ofwidth
.
-
nheight
public static void nheight(long struct, int value)
Unsafe version ofheight
.
-
nlayerCount
public static void nlayerCount(long struct, int value)
Unsafe version oflayerCount
.
-
nviewFormatCount
public static void nviewFormatCount(long struct, int value)
Sets the specified value to theviewFormatCount
field of the specifiedstruct
.
-
npViewFormats
public static void npViewFormats(long struct, @Nullable java.nio.IntBuffer value)
Unsafe version ofpViewFormats
.
-
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)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-