Class VkRenderingAttachmentLocationInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingAttachmentLocationInfo>

org.lwjgl.vulkan.VkRenderingAttachmentLocationInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkRenderingAttachmentLocationInfoKHR

public class VkRenderingAttachmentLocationInfo
extends Struct<VkRenderingAttachmentLocationInfo>
implements NativeResource

struct VkRenderingAttachmentLocationInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t colorAttachmentCount;
    uint32_t const * pColorAttachmentLocations;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderingAttachmentLocationInfo.Buffer	An array of VkRenderingAttachmentLocationInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COLORATTACHMENTCOUNT	The struct member offsets.
static final int	PCOLORATTACHMENTLOCATIONS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingAttachmentLocationInfo	calloc()	Returns a new VkRenderingAttachmentLocationInfo instance allocated with memCalloc.
static VkRenderingAttachmentLocationInfo.Buffer	calloc(int capacity)	Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated with memCalloc.
static VkRenderingAttachmentLocationInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingAttachmentLocationInfo	calloc(MemoryStack stack)	Returns a new VkRenderingAttachmentLocationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	colorAttachmentCount()
VkRenderingAttachmentLocationInfo	colorAttachmentCount(int value)	Sets the specified value to the colorAttachmentCount field.
static VkRenderingAttachmentLocationInfo	create()	Returns a new VkRenderingAttachmentLocationInfo instance allocated with BufferUtils.
static VkRenderingAttachmentLocationInfo.Buffer	create(int capacity)	Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated with BufferUtils.
static VkRenderingAttachmentLocationInfo	create(long address)	Returns a new VkRenderingAttachmentLocationInfo instance for the specified memory address.
static VkRenderingAttachmentLocationInfo.Buffer	create(long address, int capacity)	Create a VkRenderingAttachmentLocationInfo.Buffer instance at the specified memory.
static @Nullable VkRenderingAttachmentLocationInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingAttachmentLocationInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderingAttachmentLocationInfo	malloc()	Returns a new VkRenderingAttachmentLocationInfo instance allocated with memAlloc.
static VkRenderingAttachmentLocationInfo.Buffer	malloc(int capacity)	Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated with memAlloc.
static VkRenderingAttachmentLocationInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated on the specified MemoryStack.
static VkRenderingAttachmentLocationInfo	malloc(MemoryStack stack)	Returns a new VkRenderingAttachmentLocationInfo instance allocated on the specified MemoryStack.
static int	ncolorAttachmentCount(long struct)	Unsafe version of colorAttachmentCount().
static void	ncolorAttachmentCount(long struct, int value)	Sets the specified value to the colorAttachmentCount field of the specified struct.
static @Nullable IntBuffer	npColorAttachmentLocations(long struct)	Unsafe version of pColorAttachmentLocations.
static void	npColorAttachmentLocations(long struct, @Nullable IntBuffer value)	Unsafe version of pColorAttachmentLocations.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable IntBuffer	pColorAttachmentLocations()
VkRenderingAttachmentLocationInfo	pColorAttachmentLocations(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pColorAttachmentLocations field.
long	pNext()
VkRenderingAttachmentLocationInfo	pNext(long value)	Sets the specified value to the pNext field.
VkRenderingAttachmentLocationInfo	set(int sType, long pNext, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentLocations)	Initializes this struct with the specified values.
VkRenderingAttachmentLocationInfo	set(VkRenderingAttachmentLocationInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkRenderingAttachmentLocationInfo	sType(int value)	Sets the specified value to the sType field.
VkRenderingAttachmentLocationInfo	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

COLORATTACHMENTCOUNT

public static final int COLORATTACHMENTCOUNT

The struct member offsets.

PCOLORATTACHMENTLOCATIONS

public static final int PCOLORATTACHMENTLOCATIONS

The struct member offsets.

Constructor Details

VkRenderingAttachmentLocationInfo

public VkRenderingAttachmentLocationInfo(ByteBuffer container)

Creates a VkRenderingAttachmentLocationInfo 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<VkRenderingAttachmentLocationInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

colorAttachmentCount

@NativeType("uint32_t")
public int colorAttachmentCount()

Returns:

the value of the colorAttachmentCount field.

pColorAttachmentLocations

@NativeType("uint32_t const *")
public @Nullable IntBuffer pColorAttachmentLocations()

Returns:

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

sType

public VkRenderingAttachmentLocationInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkRenderingAttachmentLocationInfo sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO value to the sType field.

pNext

public VkRenderingAttachmentLocationInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

colorAttachmentCount

public VkRenderingAttachmentLocationInfo colorAttachmentCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the colorAttachmentCount field.

pColorAttachmentLocations

public VkRenderingAttachmentLocationInfo pColorAttachmentLocations(@NativeType("uint32_t const *")
 @Nullable IntBuffer value)

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

set

public VkRenderingAttachmentLocationInfo set(int sType,
 long pNext,
 int colorAttachmentCount,
 @Nullable IntBuffer pColorAttachmentLocations)

Initializes this struct with the specified values.

set

public VkRenderingAttachmentLocationInfo set(VkRenderingAttachmentLocationInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingAttachmentLocationInfo malloc()

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

calloc

public static VkRenderingAttachmentLocationInfo calloc()

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

create

public static VkRenderingAttachmentLocationInfo create()

Returns a new VkRenderingAttachmentLocationInfo instance allocated with BufferUtils.

create

public static VkRenderingAttachmentLocationInfo create(long address)

Returns a new VkRenderingAttachmentLocationInfo instance for the specified memory address.

createSafe

public static @Nullable VkRenderingAttachmentLocationInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAttachmentLocationInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingAttachmentLocationInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderingAttachmentLocationInfo.Buffer create(int capacity)

Returns a new VkRenderingAttachmentLocationInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderingAttachmentLocationInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAttachmentLocationInfo malloc(MemoryStack stack)

Returns a new VkRenderingAttachmentLocationInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderingAttachmentLocationInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkRenderingAttachmentLocationInfo.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().

ncolorAttachmentCount

public static int ncolorAttachmentCount(long struct)

Unsafe version of colorAttachmentCount().

npColorAttachmentLocations

public static @Nullable IntBuffer npColorAttachmentLocations(long struct)

Unsafe version of pColorAttachmentLocations.

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.

ncolorAttachmentCount

public static void ncolorAttachmentCount(long struct,
 int value)

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

npColorAttachmentLocations

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

Unsafe version of pColorAttachmentLocations.