VkMemoryOpaqueCaptureAddressAllocateInfoKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkMemoryOpaqueCaptureAddressAllocateInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkMemoryOpaqueCaptureAddressAllocateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Request a specific address for a memory allocation.
Description

If opaqueCaptureAddress is zero, no specific address is requested.

If opaqueCaptureAddress is not zero, it should be an address retrieved from GetDeviceMemoryOpaqueCaptureAddressKHR on an identically created memory allocation on the same implementation.

Note

In most cases, it is expected that a non-zero opaqueAddress is an address retrieved from GetDeviceMemoryOpaqueCaptureAddressKHR on an identically created memory allocation. If this is not the case, it likely that ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors will occur.

This is, however, not a strict requirement because trace capture/replay tools may need to adjust memory allocation parameters for imported memory.

If this structure is not present, it is as if opaqueCaptureAddress is zero.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO_KHR
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- opaqueCaptureAddress – the opaque capture address requested for the memory allocation.
Layout
```
 struct VkMemoryOpaqueCaptureAddressAllocateInfoKHR {
     VkStructureType sType;
     void const * pNext;
     uint64_t opaqueCaptureAddress;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer
An array of VkMemoryOpaqueCaptureAddressAllocateInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` An array of `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`OPAQUECAPTUREADDRESS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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 and Description
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR(java.nio.ByteBuffer container)` Creates a `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`calloc()` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated with `memCalloc`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`callocStack()` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`create()` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated with `BufferUtils`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`create(long address)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance for the specified memory address.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance at the specified memory.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`malloc()` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated with `memAlloc`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`mallocStack()` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkMemoryOpaqueCaptureAddressAllocateInfoKHR` instance allocated on the specified `MemoryStack`.
`static long`	`nopaqueCaptureAddress(long struct)` Unsafe version of `opaqueCaptureAddress()`.
`static void`	`nopaqueCaptureAddress(long struct, long value)` Unsafe version of `opaqueCaptureAddress`.
`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`.
`long`	`opaqueCaptureAddress()` Returns the value of the `opaqueCaptureAddress` field.
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`opaqueCaptureAddress(long value)` Sets the specified value to the `opaqueCaptureAddress` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`set(int sType, long pNext, long opaqueCaptureAddress)` Initializes this struct with the specified values.
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`set(VkMemoryOpaqueCaptureAddressAllocateInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkMemoryOpaqueCaptureAddressAllocateInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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.
  - OPAQUECAPTUREADDRESS
```
public static final int OPAQUECAPTUREADDRESS
```
    The struct member offsets.
- Constructor Detail
  - VkMemoryOpaqueCaptureAddressAllocateInfoKHR
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkMemoryOpaqueCaptureAddressAllocateInfoKHR 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - opaqueCaptureAddress
```
public long opaqueCaptureAddress()
```
    Returns the value of the opaqueCaptureAddress field.
  - sType
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - opaqueCaptureAddress
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR opaqueCaptureAddress(long value)
```
    Sets the specified value to the opaqueCaptureAddress field.
  - set
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR set(int sType,
                                                       long pNext,
                                                       long opaqueCaptureAddress)
```
    Initializes this struct with the specified values.
  - set
```
public VkMemoryOpaqueCaptureAddressAllocateInfoKHR set(VkMemoryOpaqueCaptureAddressAllocateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR malloc()
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR calloc()
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR create()
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR create(long address)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer create(long address,
                                                                        int capacity)
```
    Create a VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer createSafe(long address,
                                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR mallocStack()
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR callocStack()
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer mallocStack(int capacity,
                                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer callocStack(int capacity,
                                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkMemoryOpaqueCaptureAddressAllocateInfoKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nopaqueCaptureAddress
```
public static long nopaqueCaptureAddress(long struct)
```
    Unsafe version of opaqueCaptureAddress().
  - 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.
  - nopaqueCaptureAddress
```
public static void nopaqueCaptureAddress(long struct,
                                         long value)
```
    Unsafe version of opaqueCaptureAddress.

Class VkMemoryOpaqueCaptureAddressAllocateInfoKHR

Description

Note

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

OPAQUECAPTUREADDRESS

Constructor Detail

VkMemoryOpaqueCaptureAddressAllocateInfoKHR

Method Detail

sizeof

sType

pNext

opaqueCaptureAddress

sType

pNext

opaqueCaptureAddress

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nopaqueCaptureAddress

nsType

npNext

nopaqueCaptureAddress