Libraries.Game.Graphics.Vulkan.Commands.CopyBufferToImageCommand Documentation

Inherits from: Libraries.Game.Graphics.Vulkan.Commands.VulkanCommand, Libraries.Language.Object

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)

GetAspectMask()

Return

integer

GetBaseArrayLayer()

Return

integer

GetBufferImageHeight()

Return

integer

GetBufferOffset()

Return

integer

GetBufferRowLength()

Return

integer

GetDestinationImage()

Return

Libraries.Game.Graphics.Vulkan.VulkanImage

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

GetImageDepth()

Return

integer

GetImageHeight()

Return

integer

GetImageOffsetX()

Return

integer

GetImageOffsetY()

Return

integer

GetImageOffsetZ()

Return

integer

GetImageWidth()

Return

integer

GetLayerCount()

Return

integer

GetMipLevel()

Return

integer

GetSourceBuffer()

Return

Libraries.Game.Graphics.Vulkan.VulkanBuffer

Record(Libraries.Game.Graphics.Vulkan.VulkanCommandBuffer buffer)

Parameters

SetAspectMask(integer aspectMask)

Parameters

  • integer aspectMask

SetBaseArrayLayer(integer baseArrayLayer)

Parameters

  • integer baseArrayLayer

SetBufferImageHeight(integer bufferImageHeight)

Parameters

  • integer bufferImageHeight

SetBufferOffset(integer bufferOffset)

Parameters

  • integer bufferOffset

SetBufferRowLength(integer bufferRowLength)

Parameters

  • integer bufferRowLength

SetDestinationImage(Libraries.Game.Graphics.Vulkan.VulkanImage destinationImage)

Parameters

SetImageDepth(integer imageDepth)

Parameters

  • integer imageDepth

SetImageHeight(integer imageHeight)

Parameters

  • integer imageHeight

SetImageOffsetX(integer imageOffsetX)

Parameters

  • integer imageOffsetX

SetImageOffsetY(integer imageOffsetY)

Parameters

  • integer imageOffsetY

SetImageOffsetZ(integer imageOffsetZ)

Parameters

  • integer imageOffsetZ

SetImageWidth(integer imageWidth)

Parameters

  • integer imageWidth

SetLayerCount(integer layerCount)

Parameters

  • integer layerCount

SetMipLevel(integer mipLevel)

Parameters

  • integer mipLevel

SetSourceBuffer(Libraries.Game.Graphics.Vulkan.VulkanBuffer sourceBuffer)

Parameters