Package org.lwjgl.vulkan

Class VkFramebufferAttachmentImageInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkFramebufferAttachmentImageInfo>

org.lwjgl.vulkan.VkFramebufferAttachmentImageInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkFramebufferAttachmentImageInfoKHR

public class VkFramebufferAttachmentImageInfo
extends Struct<VkFramebufferAttachmentImageInfo>
implements NativeResource

 struct VkFramebufferAttachmentImageInfo {
     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	VkFramebufferAttachmentImageInfo.Buffer	An array of VkFramebufferAttachmentImageInfo structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	HEIGHT	The struct member offsets.
static final int	LAYERCOUNT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PVIEWFORMATS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	USAGE	The struct member offsets.
static final int	VIEWFORMATCOUNT	The struct member offsets.
static final int	WIDTH	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkFramebufferAttachmentImageInfo	calloc()	Returns a new VkFramebufferAttachmentImageInfo instance allocated with memCalloc.
static VkFramebufferAttachmentImageInfo.Buffer	calloc(int capacity)	Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with memCalloc.
static VkFramebufferAttachmentImageInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentImageInfo	calloc(MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentImageInfo	create()	Returns a new VkFramebufferAttachmentImageInfo instance allocated with BufferUtils.
static VkFramebufferAttachmentImageInfo.Buffer	create(int capacity)	Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with BufferUtils.
static VkFramebufferAttachmentImageInfo	create(long address)	Returns a new VkFramebufferAttachmentImageInfo instance for the specified memory address.
static VkFramebufferAttachmentImageInfo.Buffer	create(long address, int capacity)	Create a VkFramebufferAttachmentImageInfo.Buffer instance at the specified memory.
static @Nullable VkFramebufferAttachmentImageInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkFramebufferAttachmentImageInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkFramebufferAttachmentImageInfo	flags(int value)	Sets the specified value to the flags field.
int	height()
VkFramebufferAttachmentImageInfo	height(int value)	Sets the specified value to the height field.
int	layerCount()
VkFramebufferAttachmentImageInfo	layerCount(int value)	Sets the specified value to the layerCount field.
static VkFramebufferAttachmentImageInfo	malloc()	Returns a new VkFramebufferAttachmentImageInfo instance allocated with memAlloc.
static VkFramebufferAttachmentImageInfo.Buffer	malloc(int capacity)	Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with memAlloc.
static VkFramebufferAttachmentImageInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated on the specified MemoryStack.
static VkFramebufferAttachmentImageInfo	malloc(MemoryStack stack)	Returns a new VkFramebufferAttachmentImageInfo instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nheight(long struct)	Unsafe version of height().
static void	nheight(long struct, int value)	Unsafe version of height.
static int	nlayerCount(long struct)	Unsafe version of layerCount().
static void	nlayerCount(long struct, int value)	Unsafe version of layerCount.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable IntBuffer	npViewFormats(long struct)	Unsafe version of pViewFormats.
static void	npViewFormats(long struct, @Nullable IntBuffer value)	Unsafe version of pViewFormats.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
static int	nviewFormatCount(long struct)	Unsafe version of viewFormatCount().
static void	nviewFormatCount(long struct, int value)	Sets the specified value to the viewFormatCount field of the specified struct.
static int	nwidth(long struct)	Unsafe version of width().
static void	nwidth(long struct, int value)	Unsafe version of width.
long	pNext()
VkFramebufferAttachmentImageInfo	pNext(long value)	Sets the specified value to the pNext field.
@Nullable IntBuffer	pViewFormats()
VkFramebufferAttachmentImageInfo	pViewFormats(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pViewFormats field.
VkFramebufferAttachmentImageInfo	set(int sType, long pNext, int flags, int usage, int width, int height, int layerCount, @Nullable IntBuffer pViewFormats)	Initializes this struct with the specified values.
VkFramebufferAttachmentImageInfo	set(VkFramebufferAttachmentImageInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkFramebufferAttachmentImageInfo	sType(int value)	Sets the specified value to the sType field.
VkFramebufferAttachmentImageInfo	sType$Default()	Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType field.
int	usage()
VkFramebufferAttachmentImageInfo	usage(int value)	Sets the specified value to the usage field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	viewFormatCount()
int	width()
VkFramebufferAttachmentImageInfo	width(int value)	Sets the specified value to the width field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

USAGE

public static final int USAGE

The struct member offsets.

WIDTH

public static final int WIDTH

The struct member offsets.

HEIGHT

public static final int HEIGHT

The struct member offsets.

LAYERCOUNT

public static final int LAYERCOUNT

The struct member offsets.

VIEWFORMATCOUNT

public static final int VIEWFORMATCOUNT

The struct member offsets.

PVIEWFORMATS

public static final int PVIEWFORMATS

The struct member offsets.

Constructor Details

VkFramebufferAttachmentImageInfo

public VkFramebufferAttachmentImageInfo(ByteBuffer container)

Creates a VkFramebufferAttachmentImageInfo 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkFramebufferAttachmentImageInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

flags

public int flags()

Returns:

the value of the flags field.

usage

public int usage()

Returns:

the value of the usage field.

width

public int width()

Returns:

the value of the width field.

height

public int height()

Returns:

the value of the height field.

layerCount

public int layerCount()

Returns:

the value of the layerCount field.

viewFormatCount

public int viewFormatCount()

Returns:

the value of the viewFormatCount field.

pViewFormats

public @Nullable IntBuffer pViewFormats()

Returns:

a IntBuffer view of the data pointed to by the pViewFormats field.

sType

public VkFramebufferAttachmentImageInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkFramebufferAttachmentImageInfo sType$Default()

Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType field.

pNext

public VkFramebufferAttachmentImageInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkFramebufferAttachmentImageInfo flags(int value)

Sets the specified value to the flags field.

usage

public VkFramebufferAttachmentImageInfo usage(int value)

Sets the specified value to the usage field.

width

public VkFramebufferAttachmentImageInfo width(int value)

Sets the specified value to the width field.

height

public VkFramebufferAttachmentImageInfo height(int value)

Sets the specified value to the height field.

layerCount

public VkFramebufferAttachmentImageInfo layerCount(int value)

Sets the specified value to the layerCount field.

pViewFormats

public VkFramebufferAttachmentImageInfo pViewFormats(@Nullable IntBuffer value)

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

set

public VkFramebufferAttachmentImageInfo set(int sType,
 long pNext,
 int flags,
 int usage,
 int width,
 int height,
 int layerCount,
 @Nullable IntBuffer pViewFormats)

Initializes this struct with the specified values.

set

public VkFramebufferAttachmentImageInfo set(VkFramebufferAttachmentImageInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkFramebufferAttachmentImageInfo malloc()

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

calloc

public static VkFramebufferAttachmentImageInfo calloc()

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

create

public static VkFramebufferAttachmentImageInfo create()

Returns a new VkFramebufferAttachmentImageInfo instance allocated with BufferUtils.

create

public static VkFramebufferAttachmentImageInfo create(long address)

Returns a new VkFramebufferAttachmentImageInfo instance for the specified memory address.

createSafe

public static @Nullable VkFramebufferAttachmentImageInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkFramebufferAttachmentImageInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkFramebufferAttachmentImageInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkFramebufferAttachmentImageInfo.Buffer create(int capacity)

Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkFramebufferAttachmentImageInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkFramebufferAttachmentImageInfo malloc(MemoryStack stack)

Returns a new VkFramebufferAttachmentImageInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkFramebufferAttachmentImageInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkFramebufferAttachmentImageInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkFramebufferAttachmentImageInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nusage

public static int nusage(long struct)

Unsafe version of usage().

nwidth

public static int nwidth(long struct)

Unsafe version of width().

nheight

public static int nheight(long struct)

Unsafe version of height().

nlayerCount

public static int nlayerCount(long struct)

Unsafe version of layerCount().

nviewFormatCount

public static int nviewFormatCount(long struct)

Unsafe version of viewFormatCount().

npViewFormats

public static @Nullable IntBuffer npViewFormats(long struct)

Unsafe version of pViewFormats.

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.

nwidth

public static void nwidth(long struct,
 int value)

Unsafe version of width.

nheight

public static void nheight(long struct,
 int value)

Unsafe version of height.

nlayerCount

public static void nlayerCount(long struct,
 int value)

Unsafe version of layerCount.

nviewFormatCount

public static void nviewFormatCount(long struct,
 int value)

Sets the specified value to the viewFormatCount field of the specified struct.

npViewFormats

public static void npViewFormats(long struct,
 @Nullable IntBuffer value)

Unsafe version of pViewFormats.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate