Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageCaptureDescriptorDataInfoEXT

extends Struct<VkImageCaptureDescriptorDataInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying an image for descriptor capture.
Valid Usage
Valid Usage (Implicit)
See Also

GetImageOpaqueCaptureDescriptorDataEXT

Layout


struct VkImageCaptureDescriptorDataInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkImage image;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IMAGE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkImageCaptureDescriptorDataInfoEXT(ByteBuffer container)

Creates a VkImageCaptureDescriptorDataInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImageCaptureDescriptorDataInfoEXT
calloc()

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with memCalloc.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with memCalloc.

public static VkImageCaptureDescriptorDataInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkImageCaptureDescriptorDataInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImageCaptureDescriptorDataInfoEXT
create()

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.

public static VkImageCaptureDescriptorDataInfoEXT
create(long address)

Returns a new VkImageCaptureDescriptorDataInfoEXT instance for the specified memory address.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkImageCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.

public static VkImageCaptureDescriptorDataInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
image()

the VkImage handle of the image to get opaque capture data for.

public VkImageCaptureDescriptorDataInfoEXT
image(long value)

Sets the specified value to the image field.

public static VkImageCaptureDescriptorDataInfoEXT
malloc()

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with memAlloc.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with memAlloc.

public static VkImageCaptureDescriptorDataInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.

public static VkImageCaptureDescriptorDataInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
nimage(long struct)

Unsafe version of image.

public static void
nimage(long struct, long value)

Unsafe version of image.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageCaptureDescriptorDataInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageCaptureDescriptorDataInfoEXT
set(int sType, long pNext, long image)

Initializes this struct with the specified values.

public VkImageCaptureDescriptorDataInfoEXT

Returns:

this struct
set
(VkImageCaptureDescriptorDataInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImageCaptureDescriptorDataInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkImageCaptureDescriptorDataInfoEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImageCaptureDescriptorDataInfoEXTback to summary
protected VkImageCaptureDescriptorDataInfoEXT(long address, ByteBuffer container)
VkImageCaptureDescriptorDataInfoEXTback to summary
public VkImageCaptureDescriptorDataInfoEXT(ByteBuffer container)

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

callocback to summary
public static VkImageCaptureDescriptorDataInfoEXT calloc()

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

callocback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageCaptureDescriptorDataInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkImageCaptureDescriptorDataInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImageCaptureDescriptorDataInfoEXT create()

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImageCaptureDescriptorDataInfoEXT create(long address)

Returns a new VkImageCaptureDescriptorDataInfoEXT instance for the specified memory address.

createback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer create(int capacity)

Returns a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer create(long address, int capacity)

Create a VkImageCaptureDescriptorDataInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageCaptureDescriptorDataInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageback to summary
public long image()

the VkImage handle of the image to get opaque capture data for.

Annotations
@NativeType:VkImage
imageback to summary
public VkImageCaptureDescriptorDataInfoEXT image(long value)

Sets the specified value to the image field.

mallocback to summary
public static VkImageCaptureDescriptorDataInfoEXT malloc()

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

mallocback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageCaptureDescriptorDataInfoEXT malloc(MemoryStack stack)

Returns a new VkImageCaptureDescriptorDataInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImageCaptureDescriptorDataInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, long value)

Unsafe version of image.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageCaptureDescriptorDataInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImageCaptureDescriptorDataInfoEXT set(int sType, long pNext, long image)

Initializes this struct with the specified values.

setback to summary
public VkImageCaptureDescriptorDataInfoEXT set(VkImageCaptureDescriptorDataInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageCaptureDescriptorDataInfoEXT

the source struct

Returns:VkImageCaptureDescriptorDataInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageCaptureDescriptorDataInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImageCaptureDescriptorDataInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageCaptureDescriptorDataInfoEXT.Buffer

extends StructBuffer<VkImageCaptureDescriptorDataInfoEXT, VkImageCaptureDescriptorDataInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImageCaptureDescriptorDataInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageCaptureDescriptorDataInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkImageCaptureDescriptorDataInfoEXT
public long

Returns:

the value of the VkImageCaptureDescriptorDataInfoEXT#image field.
image
()

public VkImageCaptureDescriptorDataInfoEXT.Buffer
image(long value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#image field.

public long

Returns:

the value of the VkImageCaptureDescriptorDataInfoEXT#pNext field.
pNext
()

public VkImageCaptureDescriptorDataInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#pNext field.

protected VkImageCaptureDescriptorDataInfoEXT.Buffer
public int

Returns:

the value of the VkImageCaptureDescriptorDataInfoEXT#sType field.
sType
()

public VkImageCaptureDescriptorDataInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#sType field.

public VkImageCaptureDescriptorDataInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageCaptureDescriptorDataInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageCaptureDescriptorDataInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImageCaptureDescriptorDataInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkImageCaptureDescriptorDataInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
imageback to summary
public long image()
Returns:long

the value of the VkImageCaptureDescriptorDataInfoEXT#image field.

Annotations
@NativeType:VkImage
imageback to summary
public VkImageCaptureDescriptorDataInfoEXT.Buffer image(long value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#image field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImageCaptureDescriptorDataInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageCaptureDescriptorDataInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#pNext field.

selfback to summary
protected VkImageCaptureDescriptorDataInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImageCaptureDescriptorDataInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageCaptureDescriptorDataInfoEXT.Buffer sType(int value)

Sets the specified value to the VkImageCaptureDescriptorDataInfoEXT#sType field.

sType$Defaultback to summary
public VkImageCaptureDescriptorDataInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_CAPTURE_DESCRIPTOR_DATA_INFO_EXT value to the VkImageCaptureDescriptorDataInfoEXT#sType field.