Libraries.Game.Graphics.Vulkan.VulkanOptions Documentation

The VulkanOptions class contains data that is used to create Vulkan environments. It includes information needed during setup, such as the target API version and whether or not to use validation layers.

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
Libraries.Game.Graphics.Vulkan.VulkanSwapchainInfo swapchainInfoThe SwapchainInfo describes all of the available options that can be set when creating a Swapchain, a structure used to swap between images and render them to the screen.
integer apiVersionWhich version of the Vulkan API to target. This value should be set using the value of the ConvertToAPIVersionID action in the VulkanUtilities class. By default, this matches the DEFAULT_API_VERSION value in the VulkanConstants class.
text applicationNameThis is the application name associated with the Vulkan instance. Note that this is only used to internally refer to the application name at the Vulkan level. This can be used by external programs (e.g., hardware drivers)to identify your application, if they choose. This value defaults to "Quorum Application".
Libraries.System.Logging.Logger loggerWhat Logger the system should use to record Vulkan warnings and errors. If validation layers aren't being used, the system can record a few messages, but most warnings and errors require validation layers to be enabled. By default, this value is undefined. If this value is undefined and validation layers are enabled, a ConsoleLogger is provided by the system by default. Otherwise, if no logger is set, messages will be silently ignored. Must be set before starting the game.
integer applicationVersionThe version number of your app associated with the Vulkan instance. Similar to the application name, this is only used to refer to your application at the Vulkan level. Hardware agents such as drivers can use this to identify what version of your program is running, if they choose. This value defaults to 1.
boolean useValidationLayersWhether or not the Vulkan library should use validation layers, extra safeguards that can produce warnings or errors when there are problems. Validation layers are useful for debugging problems in the Vulkan system, but slow down the system, so they are usually only used while developing or debugging. By default, this value is false.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()