Libraries.Game.Graphics.Vulkan.VulkanSwapchainInfo Documentation

This class represents the many different parameters that are used when creating a Swapchain in Vulkan. If a value defaults to -1, then that value will be automatically set to an appropriate default value by the Swapchain.

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)

Copy()

Return

Libraries.Game.Graphics.Vulkan.VulkanSwapchainInfo

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)

GetClipped()

Return

boolean

GetColorSpace()

Return

integer

GetCompositeAlpha()

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

GetImageArrayLayers()

Return

integer

GetImageCount()

Return

integer

GetImageFormat()

Return

integer

GetImageHeight()

Return

integer

GetImageSharingMode()

Return

integer

GetImageUsage()

Return

integer

GetImageViewInfo()

Return

Libraries.Game.Graphics.Vulkan.VulkanImageViewInfo

GetImageWidth()

Return

integer

GetPreTransform()

Return

integer

GetPresentMode()

Return

integer

GetQueueFamilyIndices()

Return

Libraries.Containers.Array

SetClipped(boolean clipped)

Parameters

  • boolean clipped

SetColorSpace(integer colorSpace)

Parameters

  • integer colorSpace

SetCompositeAlpha(integer compositeAlpha)

Parameters

  • integer compositeAlpha

SetImageArrayLayers(integer imageArrayLayers)

Parameters

  • integer imageArrayLayers

SetImageCount(integer imageCount)

Parameters

  • integer imageCount

SetImageFormat(integer imageFormat)

Parameters

  • integer imageFormat

SetImageHeight(integer imageHeight)

Parameters

  • integer imageHeight

SetImageSharingMode(integer imageSharingMode)

Parameters

  • integer imageSharingMode

SetImageSize(integer width, integer height)

Parameters

  • integer width
  • integer height

SetImageUsage(integer imageUsage)

Parameters

  • integer imageUsage

SetImageViewInfo(Libraries.Game.Graphics.Vulkan.VulkanImageViewInfo imageViewInfo)

Parameters

SetImageWidth(integer imageWidth)

Parameters

  • integer imageWidth

SetPreTransform(integer preTransform)

Parameters

  • integer preTransform

SetPresentMode(integer presentMode)

Parameters

  • integer presentMode

SetQueueFamilyIndices(Libraries.Containers.Array<integer> queueFamilyIndices)

Parameters