Package org.lwjgl.vulkan

Class VkFramebufferAttachmentImageInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkFramebufferAttachmentImageInfo

org.lwjgl.vulkan.VkFramebufferAttachmentImageInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkFramebufferAttachmentImageInfoKHR
extends VkFramebufferAttachmentImageInfo

See VkFramebufferAttachmentImageInfo.

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 of VkFramebufferAttachmentImageInfoKHR structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Fields inherited from class org.lwjgl.vulkan.VkFramebufferAttachmentImageInfo

ALIGNOF, FLAGS, HEIGHT, LAYERCOUNT, PNEXT, PVIEWFORMATS, SIZEOF, STYPE, USAGE, VIEWFORMATCOUNT, WIDTH

Constructor Summary

Constructors

Constructor	Description
VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)	Creates a VkFramebufferAttachmentImageInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkFramebufferAttachmentImageInfoKHR	calloc()	Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with memCalloc.
static VkFramebufferAttachmentImageInfoKHR.Buffer	calloc(int capacity)	Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memCalloc.
static VkFramebufferAttachmentImageInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentImageInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentImageInfoKHR	callocStack()	Deprecated.
static VkFramebufferAttachmentImageInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkFramebufferAttachmentImageInfoKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFramebufferAttachmentImageInfoKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFramebufferAttachmentImageInfoKHR	create()	Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with BufferUtils.
static VkFramebufferAttachmentImageInfoKHR.Buffer	create(int capacity)	Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with BufferUtils.
static VkFramebufferAttachmentImageInfoKHR	create(long address)	Returns a new VkFramebufferAttachmentImageInfoKHR instance for the specified memory address.
static VkFramebufferAttachmentImageInfoKHR.Buffer	create(long address, int capacity)	Create a VkFramebufferAttachmentImageInfoKHR.Buffer instance at the specified memory.
static VkFramebufferAttachmentImageInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkFramebufferAttachmentImageInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkFramebufferAttachmentImageInfoKHR	flags(int value)	Sets the specified value to the flags field.
VkFramebufferAttachmentImageInfoKHR	height(int value)	Sets the specified value to the height field.
VkFramebufferAttachmentImageInfoKHR	layerCount(int value)	Sets the specified value to the layerCount field.
static VkFramebufferAttachmentImageInfoKHR	malloc()	Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with memAlloc.
static VkFramebufferAttachmentImageInfoKHR.Buffer	malloc(int capacity)	Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memAlloc.
static VkFramebufferAttachmentImageInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkFramebufferAttachmentImageInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack.
static VkFramebufferAttachmentImageInfoKHR	mallocStack()	Deprecated.
static VkFramebufferAttachmentImageInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkFramebufferAttachmentImageInfoKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFramebufferAttachmentImageInfoKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
VkFramebufferAttachmentImageInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkFramebufferAttachmentImageInfoKHR	pViewFormats(java.nio.IntBuffer value)	Sets the address of the specified IntBuffer to the pViewFormats 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.
VkFramebufferAttachmentImageInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkFramebufferAttachmentImageInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType field.
VkFramebufferAttachmentImageInfoKHR	usage(int value)	Sets the specified value to the usage field.
VkFramebufferAttachmentImageInfoKHR	width(int value)	Sets the specified value to the width field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.vulkan.VkFramebufferAttachmentImageInfo

flags, height, layerCount, nflags, nflags, nheight, nheight, nlayerCount, nlayerCount, npNext, npNext, npViewFormats, npViewFormats, nsType, nsType, nusage, nusage, nviewFormatCount, nviewFormatCount, nwidth, nwidth, pNext, pViewFormats, set, sizeof, sType, usage, validate, viewFormatCount, width

Constructor Detail

VkFramebufferAttachmentImageInfoKHR

public VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)

Creates a VkFramebufferAttachmentImageInfoKHR instance at the current position of the specified ByteBuffer 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

sType

public VkFramebufferAttachmentImageInfoKHR sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkFramebufferAttachmentImageInfo

sType$Default

public VkFramebufferAttachmentImageInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType field.

Overrides:

sType$Default in class VkFramebufferAttachmentImageInfo

pNext

public VkFramebufferAttachmentImageInfoKHR pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkFramebufferAttachmentImageInfo

flags

public VkFramebufferAttachmentImageInfoKHR flags(int value)

Sets the specified value to the flags field.

Overrides:

flags in class VkFramebufferAttachmentImageInfo

usage

public VkFramebufferAttachmentImageInfoKHR usage(int value)

Sets the specified value to the usage field.

Overrides:

usage in class VkFramebufferAttachmentImageInfo

width

public VkFramebufferAttachmentImageInfoKHR width(int value)

Sets the specified value to the width field.

Overrides:

width in class VkFramebufferAttachmentImageInfo

height

public VkFramebufferAttachmentImageInfoKHR height(int value)

Sets the specified value to the height field.

Overrides:

height in class VkFramebufferAttachmentImageInfo

layerCount

public VkFramebufferAttachmentImageInfoKHR layerCount(int value)

Sets the specified value to the layerCount field.

Overrides:

layerCount in class VkFramebufferAttachmentImageInfo

pViewFormats

public VkFramebufferAttachmentImageInfoKHR pViewFormats(@Nullable
                                                        java.nio.IntBuffer value)

Sets the address of the specified IntBuffer to the pViewFormats field.

Overrides:

pViewFormats in class VkFramebufferAttachmentImageInfo

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.

Overrides:

set in class VkFramebufferAttachmentImageInfo

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 new VkFramebufferAttachmentImageInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkFramebufferAttachmentImageInfoKHR calloc()

Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkFramebufferAttachmentImageInfoKHR create()

Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with BufferUtils.

create

public static VkFramebufferAttachmentImageInfoKHR create(long address)

Returns a new VkFramebufferAttachmentImageInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkFramebufferAttachmentImageInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkFramebufferAttachmentImageInfoKHR.Buffer malloc(int capacity)

Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkFramebufferAttachmentImageInfoKHR.Buffer calloc(int capacity)

Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkFramebufferAttachmentImageInfoKHR.Buffer create(int capacity)

Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkFramebufferAttachmentImageInfoKHR.Buffer create(long address,
                                                                int capacity)

Create a VkFramebufferAttachmentImageInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkFramebufferAttachmentImageInfoKHR.Buffer createSafe(long address,
                                                                    int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkFramebufferAttachmentImageInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkFramebufferAttachmentImageInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkFramebufferAttachmentImageInfoKHR.Buffer malloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)

Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

public static VkFramebufferAttachmentImageInfoKHR.Buffer calloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)

Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity