Class VFakePhysicalDevice

java.lang.Object

com.io7m.jcoronado.fake.VFakePhysicalDevice

All Implemented Interfaces:

VulkanHandleDispatchableType, VulkanHandleType, VulkanPhysicalDeviceType, com.io7m.jmulticlose.core.CloseableType, AutoCloseable

public final class VFakePhysicalDevice
extends Object
implements VulkanPhysicalDeviceType

The default fake physical device.

Constructor Summary

Constructors

Constructor	Description
VFakePhysicalDevice(VFakeInstance newInstance)	Construct a device.

Method Summary

Modifier and Type	Method	Description
void	close()	Destroy the object.
VulkanLogicalDeviceType	createLogicalDevice(VulkanLogicalDeviceCreateInfo info)	Create a new logical device from this physical device.
Optional<VulkanPhysicalDeviceDriverProperties>	driverProperties()	Retrieve the device driver properties.
Map<String, VulkanExtensionProperties>	extensions(Optional<String> layer)
VulkanPhysicalDeviceFeatures	features()
VulkanFormatProperties	formatProperties(VulkanFormat format)
Map<String, VulkanExtensionProperties>	getExtensions()
VulkanImageFormatProperties	getImageFormatProperties()
TreeMap<VulkanQueueFamilyIndex, VulkanQueueFamilyProperties>	getQueueFamilies()
Optional<VulkanPhysicalDeviceIDProperties>	idProperties()	Retrieve the device ID properties.
VulkanImageFormatProperties	imageFormatProperties(VulkanFormat format, VulkanImageKind type, VulkanImageTiling tiling, Set<VulkanImageUsageFlag> usage, Set<VulkanImageCreateFlag> flags)
VulkanInstanceType	instance()
boolean	isClosed()
Map<String, VulkanLayerProperties>	layers()
VulkanPhysicalDeviceLimits	limits()
VulkanPhysicalDeviceMemoryProperties	memory()
VulkanPhysicalDeviceProperties	properties()
SortedMap<VulkanQueueFamilyIndex, VulkanQueueFamilyProperties>	queueFamilies()
void	setExtensions(Map<String, VulkanExtensionProperties> inExtensions)	Set the extensions.
void	setFeatures(VulkanPhysicalDeviceFeatures newFeatures)	Set the features.
void	setFormatProperties(VulkanFormat format, VulkanFormatProperties newProperties)	Set properties for the format.
void	setImageFormatProperties(VulkanImageFormatProperties newImageFormatProperties)	Set the image format properties that will be reported for all formats.
void	setLimits(VulkanPhysicalDeviceLimits newLimits)	Set the limits.
void	setMemory(VulkanPhysicalDeviceMemoryProperties newMemory)	Set the memory properties.
void	setNextDevice(VFakeLogicalDevice inNextDevice)	Set the next device.
void	setProperties(VulkanPhysicalDeviceProperties newProperties)	Set the properties.

Methods inherited from class Object

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

Methods inherited from interface VulkanPhysicalDeviceType

queueFamilyFindWithFlags, queueFamilyFindWithFlags

Constructor Details

VFakePhysicalDevice

public VFakePhysicalDevice(VFakeInstance newInstance)

Construct a device.

Parameters:

newInstance - The owning instance

Method Details

getExtensions

public Map<String, VulkanExtensionProperties> getExtensions()

Returns:

The extensions

setExtensions

public void setExtensions(Map<String, VulkanExtensionProperties> inExtensions)

Set the extensions.

Parameters:

inExtensions - The extensions

getQueueFamilies

public TreeMap<VulkanQueueFamilyIndex, VulkanQueueFamilyProperties> getQueueFamilies()

Returns:

A mutable view of the queue families

setFeatures

public void setFeatures(VulkanPhysicalDeviceFeatures newFeatures)

Set the features.

Parameters:

newFeatures - The features

setLimits

public void setLimits(VulkanPhysicalDeviceLimits newLimits)

Set the limits.

Parameters:

newLimits - The limits

setMemory

public void setMemory(VulkanPhysicalDeviceMemoryProperties newMemory)

Set the memory properties.

Parameters:

newMemory - The memory properties

setImageFormatProperties

public void setImageFormatProperties(VulkanImageFormatProperties newImageFormatProperties)

Set the image format properties that will be reported for all formats.

Parameters:

newImageFormatProperties - The image format properties

getImageFormatProperties

public VulkanImageFormatProperties getImageFormatProperties()

Returns:

The image format properties that will be reported for all formats

setProperties

public void setProperties(VulkanPhysicalDeviceProperties newProperties)

Set the properties.

Parameters:

newProperties - The properties

instance

public VulkanInstanceType instance()

Specified by:

instance in interface VulkanPhysicalDeviceType

Returns:

The instance to which the physical device belongs

extensions

public Map<String, VulkanExtensionProperties> extensions(Optional<String> layer)

Specified by:

extensions in interface VulkanPhysicalDeviceType

Parameters:

layer - The layer that will be inspected for extensions

Returns:

The available device extensions

layers

public Map<String, VulkanLayerProperties> layers()

Specified by:

layers in interface VulkanPhysicalDeviceType

Returns:

The available layers

properties

public VulkanPhysicalDeviceProperties properties()

Specified by:

properties in interface VulkanPhysicalDeviceType

Returns:

The basic properties of the device

limits

public VulkanPhysicalDeviceLimits limits()

Specified by:

limits in interface VulkanPhysicalDeviceType

Returns:

The limits of the device

features

public VulkanPhysicalDeviceFeatures features()

Specified by:

features in interface VulkanPhysicalDeviceType

Returns:

The features of the device

formatProperties

public VulkanFormatProperties formatProperties(VulkanFormat format)

Specified by:

formatProperties in interface VulkanPhysicalDeviceType

Parameters:

format - The format

Returns:

The properties of the given format

setFormatProperties

public void setFormatProperties(VulkanFormat format,
 VulkanFormatProperties newProperties)

Set properties for the format.

Parameters:

format - The format

newProperties - The properties

imageFormatProperties

public VulkanImageFormatProperties imageFormatProperties(VulkanFormat format,
 VulkanImageKind type,
 VulkanImageTiling tiling,
 Set<VulkanImageUsageFlag> usage,
 Set<VulkanImageCreateFlag> flags)

Specified by:

imageFormatProperties in interface VulkanPhysicalDeviceType

Parameters:

format - The format

type - The image kind

tiling - The image tiling mode

usage - The usage flags

flags - The creation flags

Returns:

The properties of the given image format

memory

public VulkanPhysicalDeviceMemoryProperties memory()

Specified by:

memory in interface VulkanPhysicalDeviceType

Returns:

The memory properties of the device

queueFamilies

public SortedMap<VulkanQueueFamilyIndex, VulkanQueueFamilyProperties> queueFamilies()

Specified by:

queueFamilies in interface VulkanPhysicalDeviceType

Returns:

A read-only list of the available queue families

setNextDevice

public void setNextDevice(VFakeLogicalDevice inNextDevice)

Set the next device.

Parameters:

inNextDevice - The next device

createLogicalDevice

public VulkanLogicalDeviceType createLogicalDevice(VulkanLogicalDeviceCreateInfo info)

Description copied from interface: VulkanPhysicalDeviceType

Create a new logical device from this physical device.

Specified by:

createLogicalDevice in interface VulkanPhysicalDeviceType

Parameters:

info - The creation info

Returns:

A new logical device

driverProperties

public Optional<VulkanPhysicalDeviceDriverProperties> driverProperties()

Description copied from interface: VulkanPhysicalDeviceType

Retrieve the device driver properties.

Specified by:

driverProperties in interface VulkanPhysicalDeviceType

Returns:

The device driver properties, if available

idProperties

public Optional<VulkanPhysicalDeviceIDProperties> idProperties()

Description copied from interface: VulkanPhysicalDeviceType

Retrieve the device ID properties.

Specified by:

idProperties in interface VulkanPhysicalDeviceType

Returns:

The device ID properties, if available

close

public void close()

Description copied from interface: VulkanHandleType

Destroy the object.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VulkanHandleType

isClosed

public boolean isClosed()

Specified by:

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