Libraries.Game.Graphics.Vulkan.VulkanNumber32BitMappedMemory Documentation

This class represents a buffer of mapped memory used by a VulkanBuffer with the MEMORY_PROPERTY_HOST_VISIBLE_BIT property. This particular buffer stores and accesses the data as 32-bit floating point numbers.

Inherits from: 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)

Create(Libraries.Game.Graphics.Vulkan.VulkanBuffer buffer)

Dispose()

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)

Get(integer index)

Parameters

  • integer index

Return

number

GetByteSize()

This action returns the size of the mapped memory in bytes.

Return

integer:

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

GetSize()

This action returns the size of the mapped memory as a count of 32-bit numbers. For example, if the memory is 20 bytes, then this would return size = 5 (because 4 32-bit numbers fit inside the memory).

Return

integer:

Set(integer index, Libraries.Containers.Number32BitArray array)

Set(integer index, number value)

Parameters

  • integer index
  • number value

Set(integer index, Libraries.Containers.Number32BitArray array, integer arrayOffset, integer arrayItems)

Parameters

Set(Libraries.Containers.Number32BitArray array)