VkMappedMemoryRange (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkMappedMemoryRange
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a mapped memory range.
Valid Usage
- memory must be currently host mapped
- If size is not equal to WHOLE_SIZE, offset and size must specify a range contained within the currently mapped range of memory
- If size is equal to WHOLE_SIZE, offset must be within the currently mapped range of memory
- If size is equal to WHOLE_SIZE, the end of the current mapping of memory must be a multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize bytes from the beginning of the memory object.
- offset must be a multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize
- If size is not equal to WHOLE_SIZE, size must either be a multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize, or offset plus size must equal the size of memory.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
- pNext must be NULL
- memory must be a valid VkDeviceMemory handle
See Also

FlushMappedMemoryRanges, InvalidateMappedMemoryRanges

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- memory – the memory object to which this range belongs.
- offset – the zero-based byte offset from the beginning of the memory object.
- size – either the size of range, or WHOLE_SIZE to affect the range from offset to the end of the current mapping of the allocation.
Layout
```
 struct VkMappedMemoryRange {
     VkStructureType sType;
     void const * pNext;
     VkDeviceMemory memory;
     VkDeviceSize offset;
     VkDeviceSize size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkMappedMemoryRange.Buffer
An array of VkMappedMemoryRange 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`	`VkMappedMemoryRange.Buffer` An array of `VkMappedMemoryRange` structs.

Field Summary

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

Class VkMappedMemoryRange

Valid Usage

Valid Usage (Implicit)

See Also

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

MEMORY

OFFSET

SIZE

Constructor Detail

VkMappedMemoryRange

Method Detail

sizeof

sType

pNext

memory

offset

size

sType

pNext

memory

offset

size

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nmemory

noffset

nsize

nsType

npNext

nmemory

noffset

nsize