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.NativeResourceStructure 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)
sTypemust beSTRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO_KHRpNextmust beNULLflagsmust be a valid combination ofVkImageCreateFlagBitsvaluesusagemust be a valid combination ofVkImageUsageFlagBitsvaluesusagemust not be 0- If
viewFormatCountis not 0,pViewFormatsmust be a valid pointer to an array ofviewFormatCountvalidVkFormatvalues
See Also
VkFramebufferAttachmentsCreateInfoKHRMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– a bitmask ofVkImageCreateFlagBits, matching the value ofVkImageCreateInfo::flagsused to create an image that will be used with this framebuffer.usage– a bitmask ofVkImageUsageFlagBits, matching the value ofVkImageCreateInfo::usageused 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 thepViewFormatsarray, matching the value ofVkImageFormatListCreateInfoKHR::viewFormatCountused 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 classVkFramebufferAttachmentImageInfoKHR.BufferAn array ofVkFramebufferAttachmentImageInfoKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFLAGS
HEIGHT
LAYERCOUNT
PNEXT
PVIEWFORMATSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
USAGE
VIEWFORMATCOUNT
WIDTHThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)Creates aVkFramebufferAttachmentImageInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkFramebufferAttachmentImageInfoKHRcalloc()Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated withmemCalloc.static VkFramebufferAttachmentImageInfoKHR.Buffercalloc(int capacity)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withmemCalloc.static VkFramebufferAttachmentImageInfoKHRcallocStack()Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR.BuffercallocStack(int capacity)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFramebufferAttachmentImageInfoKHRcreate()Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated withBufferUtils.static VkFramebufferAttachmentImageInfoKHR.Buffercreate(int capacity)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withBufferUtils.static VkFramebufferAttachmentImageInfoKHRcreate(long address)Returns a newVkFramebufferAttachmentImageInfoKHRinstance for the specified memory address.static VkFramebufferAttachmentImageInfoKHR.Buffercreate(long address, int capacity)Create aVkFramebufferAttachmentImageInfoKHR.Bufferinstance at the specified memory.static VkFramebufferAttachmentImageInfoKHRcreateSafe(long address)static VkFramebufferAttachmentImageInfoKHR.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkFramebufferAttachmentImageInfoKHRflags(int value)Sets the specified value to theflagsfield.intheight()Returns the value of theheightfield.VkFramebufferAttachmentImageInfoKHRheight(int value)Sets the specified value to theheightfield.intlayerCount()Returns the value of thelayerCountfield.VkFramebufferAttachmentImageInfoKHRlayerCount(int value)Sets the specified value to thelayerCountfield.static VkFramebufferAttachmentImageInfoKHRmalloc()Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated withmemAlloc.static VkFramebufferAttachmentImageInfoKHR.Buffermalloc(int capacity)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withmemAlloc.static VkFramebufferAttachmentImageInfoKHRmallocStack()Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the thread-localMemoryStack.static VkFramebufferAttachmentImageInfoKHR.BuffermallocStack(int capacity)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkFramebufferAttachmentImageInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkFramebufferAttachmentImageInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the specifiedMemoryStack.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intnheight(long struct)Unsafe version ofheight().static voidnheight(long struct, int value)Unsafe version ofheight.static intnlayerCount(long struct)Unsafe version oflayerCount().static voidnlayerCount(long struct, int value)Unsafe version oflayerCount.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.IntBuffernpViewFormats(long struct)Unsafe version ofpViewFormats.static voidnpViewFormats(long struct, java.nio.IntBuffer value)Unsafe version ofpViewFormats.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnusage(long struct)Unsafe version ofusage().static voidnusage(long struct, int value)Unsafe version ofusage.static intnviewFormatCount(long struct)Unsafe version ofviewFormatCount().static voidnviewFormatCount(long struct, int value)Sets the specified value to theviewFormatCountfield of the specifiedstruct.static intnwidth(long struct)Unsafe version ofwidth().static voidnwidth(long struct, int value)Unsafe version ofwidth.longpNext()Returns the value of thepNextfield.VkFramebufferAttachmentImageInfoKHRpNext(long value)Sets the specified value to thepNextfield.java.nio.IntBufferpViewFormats()Returns aIntBufferview of the data pointed to by thepViewFormatsfield.VkFramebufferAttachmentImageInfoKHRpViewFormats(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepViewFormatsfield.VkFramebufferAttachmentImageInfoKHRset(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.VkFramebufferAttachmentImageInfoKHRset(VkFramebufferAttachmentImageInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkFramebufferAttachmentImageInfoKHRsType(int value)Sets the specified value to thesTypefield.intusage()Returns the value of theusagefield.VkFramebufferAttachmentImageInfoKHRusage(int value)Sets the specified value to theusagefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.intviewFormatCount()Returns the value of theviewFormatCountfield.intwidth()Returns the value of thewidthfield.VkFramebufferAttachmentImageInfoKHRwidth(int value)Sets the specified value to thewidthfield.
-
-
-
Constructor Detail
-
VkFramebufferAttachmentImageInfoKHR
public VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)
Creates aVkFramebufferAttachmentImageInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
usage
public int usage()
Returns the value of theusagefield.
-
width
public int width()
Returns the value of thewidthfield.
-
height
public int height()
Returns the value of theheightfield.
-
layerCount
public int layerCount()
Returns the value of thelayerCountfield.
-
viewFormatCount
public int viewFormatCount()
Returns the value of theviewFormatCountfield.
-
pViewFormats
@Nullable public java.nio.IntBuffer pViewFormats()
Returns aIntBufferview of the data pointed to by thepViewFormatsfield.
-
sType
public VkFramebufferAttachmentImageInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkFramebufferAttachmentImageInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkFramebufferAttachmentImageInfoKHR flags(int value)
Sets the specified value to theflagsfield.
-
usage
public VkFramebufferAttachmentImageInfoKHR usage(int value)
Sets the specified value to theusagefield.
-
width
public VkFramebufferAttachmentImageInfoKHR width(int value)
Sets the specified value to thewidthfield.
-
height
public VkFramebufferAttachmentImageInfoKHR height(int value)
Sets the specified value to theheightfield.
-
layerCount
public VkFramebufferAttachmentImageInfoKHR layerCount(int value)
Sets the specified value to thelayerCountfield.
-
pViewFormats
public VkFramebufferAttachmentImageInfoKHR pViewFormats(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepViewFormatsfield.
-
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 newVkFramebufferAttachmentImageInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkFramebufferAttachmentImageInfoKHR calloc()
Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkFramebufferAttachmentImageInfoKHR create()
Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated withBufferUtils.
-
create
public static VkFramebufferAttachmentImageInfoKHR create(long address)
Returns a newVkFramebufferAttachmentImageInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkFramebufferAttachmentImageInfoKHR createSafe(long address)
-
malloc
public static VkFramebufferAttachmentImageInfoKHR.Buffer malloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkFramebufferAttachmentImageInfoKHR.Buffer calloc(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(long address, int capacity)
Create aVkFramebufferAttachmentImageInfoKHR.Bufferinstance 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 newVkFramebufferAttachmentImageInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR callocStack()
Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkFramebufferAttachmentImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFramebufferAttachmentImageInfoKHRinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity)
Returns a newVkFramebufferAttachmentImageInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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 theviewFormatCountfield 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
-
-