Class VFakeMappedMemory

java.lang.Object

com.io7m.jcoronado.fake.VFakeMappedMemory

All Implemented Interfaces:

VulkanMappedMemoryType, com.io7m.jmulticlose.core.CloseableType, AutoCloseable

public final class VFakeMappedMemory
extends Object
implements VulkanMappedMemoryType

A fake mapped memory object. Provides a real ByteBuffer backing store so that tests can write to and read from the memory.

Constructor Summary

Constructors

Constructor	Description
VFakeMappedMemory(long inSize)	A fake mapped memory object.
VFakeMappedMemory(long inOffset, long inSize)	A fake mapped memory object.

Method Summary

Modifier and Type	Method	Description
ByteBuffer	asByteBuffer()
void	close()	Unmap the memory.
void	flush()	Flush this mapped memory.
void	flushRange(long inOffset, long inSize)	Flush the given memory range.
boolean	isClosed()
boolean	isMapped()
long	offset()
long	size()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VFakeMappedMemory

public VFakeMappedMemory(long inSize)

A fake mapped memory object.

Parameters:

inSize - The size of the mapped region, in bytes

VFakeMappedMemory

public VFakeMappedMemory(long inOffset,
 long inSize)

A fake mapped memory object.

Parameters:

inOffset - The offset of the mapped region

inSize - The size of the mapped region, in bytes

Method Details

offset

public long offset()

Returns:

The offset of the mapped region

size

public long size()

Returns:

The size of the mapped region

isMapped

public boolean isMapped()

Specified by:

isMapped in interface VulkanMappedMemoryType

Returns:

true iff VulkanMappedMemoryType.close() has not been called

flushRange

public void flushRange(long inOffset,
 long inSize)

Description copied from interface: VulkanMappedMemoryType

Flush the given memory range.

Specified by:

flushRange in interface VulkanMappedMemoryType

Parameters:

inOffset - The offset

inSize - The size

See Also:

• VulkanLogicalDeviceType.flushMappedMemoryRange(VulkanMappedMemoryRange)

flush

public void flush()

Description copied from interface: VulkanMappedMemoryType

Flush this mapped memory.

Specified by:

flush in interface VulkanMappedMemoryType

See Also:

• VulkanLogicalDeviceType.flushMappedMemoryRange(VulkanMappedMemoryRange)

close

public void close()

Description copied from interface: VulkanMappedMemoryType

Unmap the memory.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VulkanMappedMemoryType

isClosed

public boolean isClosed()

Specified by:

isClosed in interface com.io7m.jmulticlose.core.CloseableType

asByteBuffer

public ByteBuffer asByteBuffer()

Specified by:

asByteBuffer in interface VulkanMappedMemoryType

Returns:

The mapped memory as a byte buffer