Libraries.Game.Graphics.Vulkan.VulkanCommandBuffer Documentation

Inherits from: Libraries.Language.Object

Actions Documentation

BeginRecording()

This action instructs the buffer to begin recording commands. Commands are recorded using classes that inherit from the "VulkanCommand" class.

Return

boolean:

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)

Create(Libraries.Game.Graphics.Vulkan.VulkanDevice device, Libraries.Game.Graphics.Vulkan.VulkanCommandPool commandPool)

Parameters

Return

boolean

Create(Libraries.Game.Graphics.Vulkan.VulkanDevice device, Libraries.Game.Graphics.Vulkan.VulkanCommandPool commandPool, integer level)

Parameters

Return

boolean

Dispose()

EndRecording()

This action closes the buffer, indicating the end of recorded commands.

Return

boolean:

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()

Record(Libraries.Game.Graphics.Vulkan.Commands.VulkanCommand command)

This action will record a command into the command buffer. The command buffer must have already been set using the BeginRecording command.

Parameters

Reset(boolean releaseResources)

This action resets the command buffer, removing any recorded commands from the buffer. If the boolean value is true, the system will also be instructed to release any internal resources it's using for the commands (but not the buffer itself -- for that, use the Dispose action instead). If the value is false, the system may preserve some resources for future use, depending on the graphics hardware's implementation.

Parameters

  • boolean releaseResources

Reset()

This action resets the command buffer, removing any recorded commands from the buffer. This will also instruct the system to release any internal resources it's using for the commands (but not the buffer itself -- for that, use the Dispose action instead).