VulkanMappedMemoryType (com.io7m.jcoronado.documentation 0.0.1-SNAPSHOT API)

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

VMAMappedMemoryType

All Known Implementing Classes:

VulkanLWJGLMappedMemory
```
public interface VulkanMappedMemoryType
extends java.lang.AutoCloseable
```
A pointer to an area of mapped memory.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.nio.ByteBuffer`	`asByteBuffer()`
`void`	`close()`	Unmap the memory.
`void`	`flush()`	Flush this mapped memory.
`void`	`flushRange(long offset, long size)`	Flush the given memory range.
`boolean`	`isMapped()`

- Method Detail
  - isMapped
```
boolean isMapped()
```
    Returns:
    
    true iff close() has not been called
  - flushRange
```
void flushRange(long offset,
                long size)
         throws VulkanException
```
    Flush the given memory range.
    
    Parameters:
    
    offset - The offset
    
    size - The size
    
    Throws:
    
    VulkanException - On errors
    
    See Also:
    
    VulkanLogicalDeviceType.flushMappedMemoryRange(VulkanMappedMemoryRange)
  - flush
```
void flush()
    throws VulkanException
```
    Flush this mapped memory.
    
    Throws:
    
    VulkanException - On errors
    
    See Also:
    
    VulkanLogicalDeviceType.flushMappedMemoryRange(VulkanMappedMemoryRange)
  - close
```
void close()
    throws VulkanException
```
    Unmap the memory.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    VulkanException - On errors
  - asByteBuffer
```
java.nio.ByteBuffer asByteBuffer()
```
    Returns:
    
    The mapped memory as a byte buffer