Libraries.Game.Graphics.Vulkan.VulkanClearValue Documentation

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)

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)

GetAlpha()

Return

number

GetBlue()

Return

number

GetDepth()

Return

number

GetGreen()

Return

number

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

GetRed()

Return

number

GetStencil()

Return

integer

IsColorClearValue()

Return

boolean

IsDepthStencilClearValue()

Return

boolean

IsDirty()

Return

boolean

ResetDirtyFlag()

SetAlpha(number alpha)

Parameters

  • number alpha

SetBlue(number blue)

Parameters

  • number blue

SetColor(number red, number green, number blue, number alpha)

Parameters

  • number red
  • number green
  • number blue
  • number alpha

SetColor(number red, number green, number blue)

Parameters

  • number red
  • number green
  • number blue

SetDepth(number depth)

Parameters

  • number depth

SetGreen(number green)

Parameters

  • number green

SetRed(number red)

Parameters

  • number red

SetStencil(integer stencil)

Parameters

  • integer stencil