Package org.lwjgl.vulkan

Class VkImageViewUsageCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageViewUsageCreateInfo>

org.lwjgl.vulkan.VkImageViewUsageCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkImageViewUsageCreateInfoKHR

public class VkImageViewUsageCreateInfo
extends Struct<VkImageViewUsageCreateInfo>
implements NativeResource

Specify the intended usage of an image view.

Description

When this structure is chained to VkImageViewCreateInfo the usage field overrides the implicit usage parameter inherited from image creation time and its value is used instead for the purposes of determining the valid usage conditions of VkImageViewCreateInfo.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO
• usage must be a valid combination of VkImageUsageFlagBits values
• usage must not be 0

Layout

 struct VkImageViewUsageCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkImageUsageFlags usage();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageViewUsageCreateInfo.Buffer	An array of VkImageViewUsageCreateInfo 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	PNEXT	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageViewUsageCreateInfo	calloc()	Returns a new VkImageViewUsageCreateInfo instance allocated with memCalloc.
static VkImageViewUsageCreateInfo.Buffer	calloc(int capacity)	Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with memCalloc.
static VkImageViewUsageCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewUsageCreateInfo	calloc(MemoryStack stack)	Returns a new VkImageViewUsageCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewUsageCreateInfo	callocStack()	Deprecated.
static VkImageViewUsageCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkImageViewUsageCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageViewUsageCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkImageViewUsageCreateInfo	create()	Returns a new VkImageViewUsageCreateInfo instance allocated with BufferUtils.
static VkImageViewUsageCreateInfo.Buffer	create(int capacity)	Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with BufferUtils.
static VkImageViewUsageCreateInfo	create(long address)	Returns a new VkImageViewUsageCreateInfo instance for the specified memory address.
static VkImageViewUsageCreateInfo.Buffer	create(long address, int capacity)	Create a VkImageViewUsageCreateInfo.Buffer instance at the specified memory.
static VkImageViewUsageCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageViewUsageCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImageViewUsageCreateInfo	malloc()	Returns a new VkImageViewUsageCreateInfo instance allocated with memAlloc.
static VkImageViewUsageCreateInfo.Buffer	malloc(int capacity)	Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with memAlloc.
static VkImageViewUsageCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkImageViewUsageCreateInfo	malloc(MemoryStack stack)	Returns a new VkImageViewUsageCreateInfo instance allocated on the specified MemoryStack.
static VkImageViewUsageCreateInfo	mallocStack()	Deprecated.
static VkImageViewUsageCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageViewUsageCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageViewUsageCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
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.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageViewUsageCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkImageViewUsageCreateInfo	set(int sType, long pNext, int usage)	Initializes this struct with the specified values.
VkImageViewUsageCreateInfo	set(VkImageViewUsageCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkImageViewUsageCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkImageViewUsageCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the sType() field.
int	usage()	a bitmask of VkImageUsageFlagBits specifying allowed usages of the image view.
VkImageViewUsageCreateInfo	usage(int value)	Sets the specified value to the usage() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

USAGE

public static final int USAGE

The struct member offsets.

Constructor Details

VkImageViewUsageCreateInfo

public VkImageViewUsageCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

usage

public int usage()

a bitmask of VkImageUsageFlagBits specifying allowed usages of the image view.

sType

public VkImageViewUsageCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageViewUsageCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the sType() field.

pNext

public VkImageViewUsageCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

usage

public VkImageViewUsageCreateInfo usage(int value)

Sets the specified value to the usage() field.

set

public VkImageViewUsageCreateInfo set(int sType,
 long pNext,
 int usage)

Initializes this struct with the specified values.

set

public VkImageViewUsageCreateInfo set(VkImageViewUsageCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageViewUsageCreateInfo malloc()

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

calloc

public static VkImageViewUsageCreateInfo calloc()

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

create

public static VkImageViewUsageCreateInfo create()

Returns a new VkImageViewUsageCreateInfo instance allocated with BufferUtils.

create

public static VkImageViewUsageCreateInfo create(long address)

Returns a new VkImageViewUsageCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkImageViewUsageCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageViewUsageCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageViewUsageCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageViewUsageCreateInfo.Buffer create(int capacity)

Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageViewUsageCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageViewUsageCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageViewUsageCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageViewUsageCreateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageViewUsageCreateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImageViewUsageCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageViewUsageCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkImageViewUsageCreateInfo malloc(MemoryStack stack)

Returns a new VkImageViewUsageCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageViewUsageCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nusage

public static int nusage(long struct)

Unsafe version of usage().

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.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.