infinity.ui¶

Provides functionality for building graphical user interfaces using the integrated Dear ImGui UI library.

Module: infinity.ui

color¶

This class represents a color, expressed in RGBA format.

Example:

infinity.loadModule('infinity.ui');
let myColor = new infinity.ui.color(r, g, b, a);

Properties

a¶

Type: number

A number representing the alpha (opacity) component.

b¶

Type: number

A number representing the green component.

g¶

Type: number

A number representing the blue component.

r¶

Type: number

A number representing the red component.

Methods

constructor()¶

Creates a new color object with the specified r, g, b, and a values. The parameters can be omitted altogether to create the object with r, g, b, and a set to 0.

Signature:

constructor( r: number, g: number, b: number, a: number )

Parameters:

• r: number

  A number representing the red component.

• g: number

  A number representing the green component.

• b: number

  A number representing the blue component.

• a: number

  A number representing the alpha (opacity) component.

Example:

infinity.loadModule('infinity.ui');
let myColor = new infinity.ui.color(r, g, b, a);

vec2¶

This class represents a 2D vector.

Example:

infinity.loadModule('infinity.ui');
let myVec2 = new infinity.ui.vec2(x, y);

Properties

x¶

Type: number

A number representing the x-coordinate.

y¶

Type: number

A number representing the y-coordinate.

Methods

constructor()¶

Creates a new vec2 object with the specified x and y values. The parameters can be omitted altogether to create the object with x and y set to 0.

Signature:

constructor( x: number, y: number )

Parameters:

• x: number

  A number representing the x-coordinate.

• y: number

  A number representing the y-coordinate.

Example:

infinity.loadModule('infinity.ui');
let myVec2 = new infinity.ui.vec2(x, y);

vec3¶

This class represents a 3D vector.

Example:

infinity.loadModule('infinity.ui');
let myVec3 = new infinity.ui.vec3(x, y, z);

Properties

x¶

Type: number

A number representing the x-coordinate.

y¶

Type: number

A number representing the y-coordinate.

z¶

Type: number

A number representing the z-coordinate.

Methods

constructor()¶

Creates a new vec3 object with the specified x, y, and z values. The parameters can be omitted altogether to create the object with x, y, and z set to 0.

Signature:

constructor( x: number, y: number, z: number )

Parameters:

• x: number

  A number representing the x-coordinate.

• y: number

  A number representing the y-coordinate.

• z: number

  A number representing the z-coordinate.

Example:

infinity.loadModule('infinity.ui');
let myVec3 = new infinity.ui.vec3(x, y, z);

vec4¶

Example:

infinity.loadModule('infinity.ui');
let myVec4 = new infinity.ui.vec4(x, y, z, w);

Properties

w¶

Type: number

A number representing the w-coordinate.

x¶

Type: number

A number representing the x-coordinate.

y¶

Type: number

A number representing the y-coordinate.

z¶

Type: number

A number representing the z-coordinate.

Methods

constructor()¶

Creates a new vec4 object with the specified x, y, z, and w values. The parameters can be omitted altogether to create the object with x, y, z, and w set to 0.

Signature:

constructor( x: number, y: number, z: number, w: number )

Parameters:

• x: number

  A number representing the x-coordinate.

• y: number

  A number representing the y-coordinate.

• z: number

  A number representing the z-coordinate.

• w: number

  A number representing the w-coordinate.

Example:

infinity.loadModule('infinity.ui');
let myVec4 = new infinity.ui.vec4(x, y, z, w);

numberArray¶

Extends: Array<number>

An array containing number elements.

stringArray¶

Extends: Array<string>

An array containing string elements.

vec2Array¶

Extends: Array<infinity.ui.vec2>

An array containing elements of the vec2 class.

addBezierCubic()¶

Draws a cubic Bezier curve on the UI using specified control points and styling.

Signature:

addBezierCubic( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, p4: infinity.ui.vec2, col: number, thickness?: number, segments?: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first control point of the Bezier curve, of type infinity.ui.vec2.

• p2: infinity.ui.vec2

  The second control point of the Bezier curve, of type infinity.ui.vec2.

• p3: infinity.ui.vec2

  The third control point of the Bezier curve, of type infinity.ui.vec2.

• p4: infinity.ui.vec2

  The fourth control point of the Bezier curve, of type infinity.ui.vec2.

• col: number

  A number representing the color of the curve.

• thickness: number, optional

  A number specifying the thickness of the curve. If not provided, a default value will be used.

• segments: number, optional

  A number specifying the number of segments to divide the curve into. More segments results in a smoother curve. If not provided, a default value will be used.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addBezierCubic(p1, p2, p3, p4, col);

addBezierQuadratic()¶

Draws a quadratic Bezier curve on the UI using specified control points and styling.

Signature:

addBezierQuadratic( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, col: number, thickness?: number, segments?: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first control point of the Bezier curve, of type infinity.ui.vec2.

• p2: infinity.ui.vec2

  The second control point of the Bezier curve, of type infinity.ui.vec2.

• p3: infinity.ui.vec2

  The third control point of the Bezier curve, of type infinity.ui.vec2.

• col: number

  A number representing the color of the curve.

• thickness: number, optional

  A number specifying the thickness of the curve. If not provided, a default value will be used.

• segments: number, optional

  A number specifying the number of segments to divide the curve into. More segments results in a smoother curve. If not provided, a default value will be used.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addBezierQuadratic(p1, p2, p3, col);

addCircle()¶

Draws a circle on the UI using the specified center point, radius, and styling.

Signature:

addCircle( center: infinity.ui.vec2, radius: number, col: number, segments?: number, thickness?: number ): void

Parameters:

• center: infinity.ui.vec2

  The center point of the circle, of type infinity.ui.vec2.

• radius: number

  A number representing the radius of the circle.

• col: number

  A number representing the color of the circle.

• segments: number, optional

  A number specifying the number of segments to divide the circle into. More segments results in a smoother circle. If not provided, a default value will be used.

• thickness: number, optional

  A number specifying the thickness of the circle. If not provided, a default value will be used.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addCircle(center, radius, col);

addCircleFilled()¶

Draws a filled circle on the UI using the specified center point, radius, and styling.

Signature:

addCircleFilled( center: infinity.ui.vec2, radius: number, col: number, segments?: number ): void

Parameters:

• center: infinity.ui.vec2

  The center point of the circle, of type infinity.ui.vec2.

• radius: number

  A number representing the radius of the circle.

• col: number

  A number representing the color of the circle.

• segments: number, optional

  A number specifying the number of segments to divide the circle into. More segments results in a smoother circle. If not provided, a default value will be used.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addCircleFilled(center, radius, col);

addConvexPolyFilled()¶

Draws a filled convex polygon on the UI, using the specified points and color.

Signature:

addConvexPolyFilled( points: infinity.ui.vec2Array, col: number ): void

Parameters:

• points: infinity.ui.vec2Array

  An array of infinity.ui.vec2 objects, representing the vertices of the convex polygon in order. The order should form a convex shape.

• col: number

  A number representing the color of the polygon.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addConvexPolyFilled(points, col);

addFontFromFile()¶

Adds a new font from a file to the UI and returns a unique ID associated with the loaded font. Returns an identifier that can be used to reference the added font

Signature:

addFontFromFile( fileName: string, size: number ): number

Parameters:

• fileName: string

  The name of the file that contains the font. This should include the file's path if it's not located in the program's default directory.

• size: number

  The desired size of the font.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.addFontFromFile(fileName, size);

addImage()¶

Adds an image to the UI, using the specified texture, position points, optional UV coordinates, and color.

Signature:

addImage( texture: number, p1: infinity.ui.vec2, p2: infinity.ui.vec2, uv1?: infinity.ui.vec2, uv2?: infinity.ui.vec2, col?: number ): void

Parameters:

• texture: number

  The identifier for the texture to be used.

• p1: infinity.ui.vec2

  The bottom-left position point of the image in 2D space.

• p2: infinity.ui.vec2

  The top-right position point of the image in 2D space.

• uv1: infinity.ui.vec2, optional

  The bottom-left UV coordinate for the image. Determines the part of the texture to be used. Defaults to (0,0) if not provided.

• uv2: infinity.ui.vec2, optional

  The top-right UV coordinate for the image. Determines the part of the texture to be used. Defaults to (1,1) if not provided.

• col: number, optional

  The color modifier for the image. Defaults to white (no color modification) if not provided.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addImage(texture, p1, p2);

addImageQuad()¶

Adds an image to the UI as a quadrilateral, using the specified texture, position points, optional UV coordinates, and color.

Signature:

addImageQuad( texture: number, p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, p4: infinity.ui.vec2, uv1?: infinity.ui.vec2, uv2?: infinity.ui.vec2, uv3?: infinity.ui.vec2, uv4?: infinity.ui.vec2, col?: number ): void

Parameters:

• texture: number

  This is the identifier for the texture to be used.

• p1: infinity.ui.vec2

  The first position point of the image quadrilateral in 2D space.

• p2: infinity.ui.vec2

  The second position point of the image quadrilateral in 2D space.

• p3: infinity.ui.vec2

  The third position point of the image quadrilateral in 2D space.

• p4: infinity.ui.vec2

  The fourth position point of the image quadrilateral in 2D space.

• uv1: infinity.ui.vec2, optional

  The first UV coordinate for the image. It determines the part of the texture to be used for the first position point.

• uv2: infinity.ui.vec2, optional

  The second UV coordinate for the image. It determines the part of the texture to be used for the second position point.

• uv3: infinity.ui.vec2, optional

  The third UV coordinate for the image. It determines the part of the texture to be used for the third position point.

• uv4: infinity.ui.vec2, optional

  The fourth UV coordinate for the image. It determines the part of the texture to be used for the fourth position point.

• col: number, optional

  The color modifier for the image.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addImageQuad(texture, p1, p2, p3, p4);

addImageRounded()¶

Adds an image with rounded corners to the UI, using the specified texture, position points, optional UV coordinates, color, rounding radius, and drawing flags.

Signature:

addImageRounded( texture: number, p1: infinity.ui.vec2, p2: infinity.ui.vec2, uv1?: infinity.ui.vec2, uv2?: infinity.ui.vec2, col?: number, rounding?: number, flags?: infinity.ui.drawFlags ): void

Parameters:

• texture: number

  The identifier for the texture to be used.

• p1: infinity.ui.vec2

  The bottom-left position point of the image in 2D space.

• p2: infinity.ui.vec2

  The top-right position point of the image in 2D space.

• uv1: infinity.ui.vec2, optional

  The bottom-left UV coordinate for the image. It determines the part of the texture to be used.

• uv2: infinity.ui.vec2, optional

  The top-right UV coordinate for the image. It determines the part of the texture to be used.

• col: number, optional

  The color modifier for the image.

• rounding: number, optional

  The radius of the rounding for the corners of the image.

• flags: infinity.ui.drawFlags, optional

  These are flags to customize the image drawing behavior.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addImageRounded(texture, p1, p2);

addLine()¶

Adds a line to the UI, using the specified start and end points, color, and optional thickness.

Signature:

addLine( p1: infinity.ui.vec2, p2: infinity.ui.vec2, col: number, thickness?: number ): void

Parameters:

• p1: infinity.ui.vec2

  The start position point of the line in 2D space.

• p2: infinity.ui.vec2

  The end position point of the line in 2D space.

• col: number

  The color of the line.

• thickness: number, optional

  The thickness of the line.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addLine(p1, p2, col);

addNgon()¶

Adds an n-gon (a polygon with "n" sides) to the UI, using the specified center point, radius, color, number of segments, and optional thickness.

Signature:

addNgon( center: infinity.ui.vec2, radius: number, col: number, segments: number, thickness?: number ): void

Parameters:

• center: infinity.ui.vec2

  The center point of the n-gon in 2D space.

• radius: number

  The radius of the n-gon.

• col: number

  The color of the n-gon.

• segments: number

  The number of sides or segments of the n-gon.

• thickness: number, optional

  The thickness of the n-gon.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addNgon(center, radius, col, segments);

addNgonFilled()¶

Adds a filled n-gon (a polygon with "n" sides) to the UI, using the specified center point, radius, color, and number of segments.

Signature:

addNgonFilled( center: infinity.ui.vec2, radius: number, col: number, segments: number ): void

Parameters:

• center: infinity.ui.vec2

  The center point of the n-gon in 2D space.

• radius: number

  The radius of the n-gon.

• col: number

  The color of the n-gon.

• segments: number

  The number of sides or segments of the n-gon.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addNgonFilled(center, radius, col, segments);

addPolyline()¶

Adds a polyline (a line made up of several segments) to the UI, using the specified points array, color, optional drawing flags, and optional thickness.

Signature:

addPolyline( points: infinity.ui.vec2Array, col: number, flags?: infinity.ui.drawFlags, thickness?: number ): void

Parameters:

• points: infinity.ui.vec2Array

  The array of points defining the segments of the polyline in 2D space.

• col: number

  The color of the polyline.

• flags: infinity.ui.drawFlags, optional

  Flags to customize the polyline drawing behavior.

• thickness: number, optional

  The thickness of the polyline.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addPolyline(points, col);

addQuad()¶

Adds a quadrilateral (a polygon with four sides) to the UI, using the specified four points, color, and optional thickness.

Signature:

addQuad( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, p4: infinity.ui.vec2, col: number, thickness?: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first point of the quadrilateral in 2D space.

• p2: infinity.ui.vec2

  The second point of the quadrilateral in 2D space.

• p3: infinity.ui.vec2

  The third point of the quadrilateral in 2D space.

• p4: infinity.ui.vec2

  The fourth point of the quadrilateral in 2D space.

• col: number

  The color of the quadrilateral.

• thickness: number, optional

  The thickness of the quadrilateral.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addQuad(p1, p2, p3, p4, col);

addQuadFilled()¶

Adds a filled quadrilateral (a polygon with four sides) to the UI, using the specified four points and color.

Signature:

addQuadFilled( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, p4: infinity.ui.vec2, col: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first point of the quadrilateral in 2D space.

• p2: infinity.ui.vec2

  The second point of the quadrilateral in 2D space.

• p3: infinity.ui.vec2

  The third point of the quadrilateral in 2D space.

• p4: infinity.ui.vec2

  The fourth point of the quadrilateral in 2D space.

• col: number

  The color of the quadrilateral.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addQuadFilled(p1, p2, p3, p4, col);

addRect()¶

Adds a rectangle to the UI, using the specified two points (representing opposite corners), color, optional rounding for the corners, optional drawing flags, and optional thickness.

Signature:

addRect( p1: infinity.ui.vec2, p2: infinity.ui.vec2, col: number, rounding?: number, flags?: infinity.ui.drawFlags, thickness?: number ): void

Parameters:

• p1: infinity.ui.vec2

  One corner point of the rectangle in 2D space.

• p2: infinity.ui.vec2

  The diagonally opposite corner point of the rectangle in 2D space.

• col: number

  The color of the rectangle.

• rounding: number, optional

  The radius of rounding for the corners of the rectangle.

• flags: infinity.ui.drawFlags, optional

  Flags to customize the rectangle drawing behavior.

• thickness: number, optional

  The thickness of the rectangle's outline.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addRect(p1, p2, col);

addRectFilled()¶

Adds a filled rectangle to the UI, using the specified two points (representing opposite corners), color, and optional rounding for the corners, and optional drawing flags.

Signature:

addRectFilled( p1: infinity.ui.vec2, p2: infinity.ui.vec2, col: number, rounding?: number, flags?: infinity.ui.drawFlags ): void

Parameters:

• p1: infinity.ui.vec2

  One corner point of the rectangle in 2D space.

• p2: infinity.ui.vec2

  The diagonally opposite corner point of the rectangle in 2D space.

• col: number

  The color of the rectangle.

• rounding: number, optional

  The radius of rounding for the corners of the rectangle.

• flags: infinity.ui.drawFlags, optional

  Flags to customize the rectangle drawing behavior.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addRectFilled(p1, p2, col);

addRectFilledMultiColor()¶

Adds a filled rectangle with multiple colors to the UI. The rectangle is defined by the specified two points (representing opposite corners). Each corner has its own color, allowing for a gradient effect.

Signature:

addRectFilledMultiColor( p1: infinity.ui.vec2, p2: infinity.ui.vec2, col1: number, col2: number, col3: number, col4: number ): void

Parameters:

• p1: infinity.ui.vec2

  One corner point of the rectangle in 2D space.

• p2: infinity.ui.vec2

  The diagonally opposite corner point of the rectangle in 2D space.

• col1: number

  The color of the first corner of the rectangle.

• col2: number

  The color of the second corner of the rectangle.

• col3: number

  The color of the third corner of the rectangle.

• col4: number

  The color of the fourth corner of the rectangle.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addRectFilledMultiColor(p1, p2, col1, col2, col3, col4);

¶

addText()¶

Adds a piece of text to the UI at the specified position and with the given color.

Signature:

addText( pos: infinity.ui.vec2, col: number, text: string ): void

Parameters:

• pos: infinity.ui.vec2

  The position on the UI where the text should be placed.

• col: number

  The color to be used for the text.

• text: string

  The string of text to be added to the UI.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addText(pos, col, text);

addText()¶

Adds a piece of text to the UI at the specified position and with the given style.

Signature:

addText( font: number, size: number, pos: infinity.ui.vec2, col: number, text: string, wrapWidth?: number ): void

Parameters:

• font: number

  The font to be used for the text.

• size: number

  The size of the font to be used.

• pos: infinity.ui.vec2

  The position on the UI where the text should be placed.

• col: number

  The color to be used for the text.

• text: string

  The string of text to be added to the UI.

• wrapWidth: number, optional

  The width at which the text should wrap onto a new line.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addText(font, size, pos, col, text);

addTriangle()¶

Draws a triangle to the UI using the specified points and color.

Signature:

addTriangle( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, col: number, thickness?: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first point of the triangle in 2D space.

• p2: infinity.ui.vec2

  The second point of the triangle in 2D space.

• p3: infinity.ui.vec2

  The third point of the triangle in 2D space.

• col: number

  The color of the triangle.

• thickness: number, optional

  The thickness of the triangle's outline.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addTriangle(p1, p2, p3, col);

addTriangleFilled()¶

Draws a filled triangle on the UI using the specified points and color.

Signature:

addTriangleFilled( p1: infinity.ui.vec2, p2: infinity.ui.vec2, p3: infinity.ui.vec2, col: number ): void

Parameters:

• p1: infinity.ui.vec2

  The first point of the triangle in 2D space.

• p2: infinity.ui.vec2

  The second point of the triangle in 2D space.

• p3: infinity.ui.vec2

  The third point of the triangle in 2D space.

• col: number

  The color of the triangle.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.addTriangleFilled(p1, p2, p3, col);

alignTextToFramePadding()¶

Aligns the text within the UI's frame padding.

Signature:

alignTextToFramePadding(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.alignTextToFramePadding();

arrowButton()¶

Creates an arrow button on the UI with the specified id and direction. Returns a boolean indicating whether the button was clicked or not.

Signature:

arrowButton( id: string, direction: infinity.ui.directions ): boolean

Parameters:

• id: string

  The unique identifier for the arrow button.

• direction: infinity.ui.directions

  The direction the arrow on the button is pointing.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.arrowButton(id, direction) ) {}

begin()¶

Begins a new window with the specified name and optional show close button flag and window flags. The window state, represented by infinity.ui.windowStates, is returned after the function call.

Signature:

begin( name: string, showCloseButton?: boolean, flags?: infinity.ui.windowFlags ): infinity.ui.windowStates

Parameters:

• name: string

  The name for the new window.

• showCloseButton: boolean, optional

  A boolean value indicating whether to display a close button in the new window.

• flags: infinity.ui.windowFlags, optional

  Optional flags that control the behavior of the new window.

Return type: infinity.ui.windowStates

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.begin(name);

beginChild()¶

Begins a new child window with the specified id, size, border, and window flags. Returns a boolean indicating whether the child window was successfully created.

Signature:

beginChild( id: string | number, size?: infinity.ui.vec2, border?: boolean, flags?: infinity.ui.windowFlags ): boolean

Parameters:

• id: string | number

  The unique identifier for the child window.

• size: infinity.ui.vec2, optional

  The size of the child window in 2D space.

• border: boolean, optional

  A boolean value indicating whether to display a border around the child window.

• flags: infinity.ui.windowFlags, optional

  Optional flags that control the behavior of the child window.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginChild(id) ) {}

beginChildFrame()¶

Begins a new child frame with the specified id, size, and window flags. Returns a boolean indicating whether the child frame was successfully created.

Signature:

beginChildFrame( id: number, size: infinity.ui.vec2, flags?: infinity.ui.windowFlags ): boolean

Parameters:

• id: number

  The unique identifier for the child frame.

• size: infinity.ui.vec2

  The size of the child frame in 2D space.

• flags: infinity.ui.windowFlags, optional

  Optional flags that control the behavior of the child frame.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginChildFrame(id, size) ) {}

beginCombo()¶

Begins a new combo box with the specified label, preview value, and combo flags. Returns a boolean indicating whether the combo box was successfully created.

Signature:

beginCombo( label: string, previewValue: string, flags?: infinity.ui.comboFlags ): boolean

Parameters:

• label: string

  The text that appears as the combo box label.

• previewValue: string

  The text displayed as the preview value in the combo box.

• flags: infinity.ui.comboFlags, optional

  Optional flags that control the behavior of the combo box.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginCombo(label, previewValue) ) {}

beginDisabled()¶

Starts a new disabled block in the UI, based on the specified disabled state.

Signature:

beginDisabled( disabled: boolean ): void

Parameters:

• disabled: boolean

  A boolean indicating whether the block should be disabled.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.beginDisabled(disabled);

beginGroup()¶

Initiates a new group in the UI.

Signature:

beginGroup(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.beginGroup();

beginListBox()¶

Initiates a new list box with a specific label and optional size. Returns a boolean indicating whether the main menu bar was successfully created.

Signature:

beginListBox( label: string, size?: infinity.ui.vec2 ): boolean

Parameters:

• label: string

  The text that appears as the list box label.

• size: infinity.ui.vec2, optional

  The 2D dimensions of the list box, if specified.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginListBox(label) ) {}

beginMainMenuBar()¶

Initiates a new main menu bar in the UI. Returns a boolean indicating whether the main menu bar was successfully created.

Signature:

beginMainMenuBar(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginMainMenuBar() ) {}

beginMenu()¶

Initiates a new menu in the UI with the provided label. Returns a boolean indicating whether the menu was successfully created.

Signature:

beginMenu( label: string, enabled?: boolean ): boolean

Parameters:

• label: string

  The text that appears as the menu label.

• enabled: boolean, optional

  Indicates whether the menu is enabled or disabled.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginMenu(label) ) {}

beginMenuBar()¶

Initiates a new menu bar in the UI. Returns a boolean indicating whether the menu bar was successfully created.

Signature:

beginMenuBar(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginMenuBar() ) {}

beginPopup()¶

Initiates a new popup in the UI with the provided identifier. Returns a boolean indicating whether the popup was successfully created.

Signature:

beginPopup( id: string, flags?: infinity.ui.windowFlags ): boolean

Parameters:

• id: string

  A unique identifier for the popup.

• flags: infinity.ui.windowFlags, optional

  Specifies optional flags for the popup window.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginPopup(id) ) {}

beginPopupContextItem()¶

Initiates a new context-specific popup in the UI. Returns a boolean indicating whether the popup was successfully created.

Signature:

beginPopupContextItem( id?: string, flags?: infinity.ui.popupFlags ): boolean

Parameters:

• id: string, optional

  A unique identifier for the context-specific popup.

• flags: infinity.ui.popupFlags, optional

  Specifies optional flags for the popup.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginPopupContextItem() ) {}

beginPopupContextVoid()¶

Initiates a new context-agnostic popup in the UI. Returns a boolean indicating whether the popup was successfully created.

Signature:

beginPopupContextVoid( id?: string, flags?: infinity.ui.popupFlags ): boolean

Parameters:

• id: string, optional

  A unique identifier for the context-agnostic popup.

• flags: infinity.ui.popupFlags, optional

  Specifies optional flags for the popup.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginPopupContextVoid() ) {}

beginPopupContextWindow()¶

Initiates a new window-specific popup in the UI. Returns a boolean indicating whether the popup was successfully created.

Signature:

beginPopupContextWindow( id?: string, flags?: infinity.ui.popupFlags ): boolean

Parameters:

• id: string, optional

  A unique identifier for the window-specific popup.

• flags: infinity.ui.popupFlags, optional

  Specifies optional flags for the popup.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginPopupContextWindow() ) {}

beginPopupModal()¶

Initiates a new modal popup with the specified name. Returns a boolean indicating whether the modal popup was successfully created.

Signature:

beginPopupModal( name: string, open?: boolean, flags?: infinity.ui.windowFlags ): boolean

Parameters:

• name: string

  The name of the modal popup.

• open: boolean, optional

  Specifies whether the modal popup should be open upon creation.

• flags: infinity.ui.windowFlags, optional

  Specifies optional flags for the modal popup.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginPopupModal(name) ) {}

beginTabBar()¶

Initiates a new tab bar with the given ID. Returns a boolean indicating whether the tab bar was successfully created.

Signature:

beginTabBar( id: string, flags?: infinity.ui.tabBarFlags ): boolean

Parameters:

• id: string

  The ID for the tab bar.

• flags: infinity.ui.tabBarFlags, optional

  Specifies optional flags for the tab bar.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginTabBar(id) ) {}

beginTabItem()¶

Initiates a new tab item with the given label. Returns a boolean indicating whether the tab item was successfully created.

Signature:

beginTabItem( label: string, open?: boolean, flags?: infinity.ui.tabItemFlags ): boolean

Parameters:

• label: string

  The label for the tab item.

• open: boolean, optional

  Specifies whether the tab item is open.

• flags: infinity.ui.tabItemFlags, optional

  Specifies optional flags for the tab item.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginTabItem(label) ) {}

beginTable()¶

Begins a new table with the specified ID and number of columns. Returns a boolean indicating whether the table was successfully created.

Signature:

beginTable( id: string, column: number, flags?: infinity.ui.tableFlags, outerSize?: infinity.ui.vec2, innerWidth?: number ): boolean

Parameters:

• id: string

  The ID for the table.

• column: number

  The number of columns in the table.

• flags: infinity.ui.tableFlags, optional

  Specifies optional flags for the table.

• outerSize: infinity.ui.vec2, optional

  Specifies the outer size of the table.

• innerWidth: number, optional

  Specifies the inner width of the table.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.beginTable(id, column) ) {}

beginTooltip()¶

Commences the creation of a new tooltip. A tooltip is a contextual element that displays information about other interface elements when the user hovers over them. The tooltip can include text or other UI components. After calling this function, you can add components to the tooltip. To finish and display the tooltip, use the corresponding endTooltip function.

Signature:

beginTooltip(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.beginTooltip();

bullet()¶

Draws a small circular bullet point in the current layout context.

Signature:

bullet(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.bullet();

bulletText()¶

Renders a bullet point marker followed by the provided text.

Signature:

bulletText( text: string ): void

Parameters:

• text: string

  Text to be displayed next to the bullet point.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.bulletText(text);

button()¶

Creates a button with a label and optional size. Returns true when the button is clicked.

Signature:

button( label: string, size?: infinity.ui.vec2 ): boolean

Parameters:

• label: string

  Label displayed on the button.

• size: infinity.ui.vec2, optional

  Vector specifying the width and height of the button in pixels.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.button(label) ) {}

calcItemWidth()¶

Calculates the width of an item in the current context. Returns the width of the item in the current context. Used typically when determining the appropriate size for the next item or widget in the layout.

Signature:

calcItemWidth(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.calcItemWidth();

calcTextSize()¶

Calculates the size of a given text string. Returns an infinity.ui.vec2 object, where the x value is the width of the text and the y value is the height. The size takes into account potential text wrapping at the specified wrapWidth.

Signature:

calcTextSize( text: string, wrapWidth?: number ): infinity.ui.vec2

Parameters:

• text: string

  The text string for which the size should be calculated.

• wrapWidth: number, optional

  The width at which the text string should wrap.

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.calcTextSize(text);

checkbox()¶

Creates a checkbox with the specified label. Returns a boolean indicating whether the state of the checkbox has changed after the function call.

Signature:

checkbox( label: string, checked: boolean ): boolean

Parameters:

• label: string

  The label to be displayed next to the checkbox.

• checked: boolean

  The current state of the checkbox.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.checkbox(label, checked) ) {}

closeCurrentPopup()¶

Closes the currently active popup.

Signature:

closeCurrentPopup(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.closeCurrentPopup();

collapsingHeader()¶

Creates a collapsible header section in the user interface. Returns the current state of the header.

Signature:

collapsingHeader( label: string, visible: boolean, flags?: infinity.ui.treeNodeFlags ): infinity.ui.collapsingHeaderStates

Parameters:

• label: string

  The displayed name of the collapsible header.

• visible: boolean

  A flag determining if the header starts in an expanded or collapsed state.

• flags: infinity.ui.treeNodeFlags, optional

  Flags that further customize the behavior or appearance of the collapsible header.

Return type: infinity.ui.collapsingHeaderStates

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.collapsingHeader(label, visible);

collapsingHeader()¶

Creates a collapsible header section in the user interface. Returns the current state of the header.

Signature:

collapsingHeader( label: string, flags?: infinity.ui.treeNodeFlags ): infinity.ui.collapsingHeaderStates

Parameters:

• label: string

  The displayed name of the collapsible header.

• flags: infinity.ui.treeNodeFlags, optional

  Flags that further customize the behavior or appearance of the collapsible header.

Return type: infinity.ui.collapsingHeaderStates

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.collapsingHeader(label);

colorButton()¶

Displays a color button in the user interface. Returns true if the button is pressed, otherwise false.

Signature:

colorButton( id: string, color: infinity.ui.color, flags?: infinity.ui.colorEditFlags, size?: infinity.ui.vec2 ): boolean

Parameters:

• id: string

  The identifier for the color button.

• color: infinity.ui.color

  The initial color value displayed by the button.

• flags: infinity.ui.colorEditFlags, optional

  Flags that dictate how the color editing behaves or appears.

• size: infinity.ui.vec2, optional

  Specifies the size of the color button.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.colorButton(id, color) ) {}

colorConvertFloat4ToU32()¶

Converts a color from the infinity.ui.color format to a 32-bit unsigned integer format. Returns the color value as a 32-bit unsigned integer.

Signature:

colorConvertFloat4ToU32( color: infinity.ui.color ): number

Parameters:

• color: infinity.ui.color

  The color value that needs to be converted.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.colorConvertFloat4ToU32(color);

colorConvertU32ToFloat4()¶

Converts a color from a 32-bit unsigned integer format to the infinity.ui.color format. Returns the color value in the infinity.ui.color format.

Signature:

colorConvertU32ToFloat4( color: number ): infinity.ui.color

Parameters:

• color: number

  The 32-bit unsigned integer representing the color that needs to be converted.

Return type: infinity.ui.color

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.colorConvertU32ToFloat4(color);

colorEdit()¶

Creates a color edit UI widget that allows modification of an infinity.ui.color value. Returns the modified color value in the infinity.ui.color format.

Signature:

colorEdit( label: string, color: infinity.ui.color, flags?: infinity.ui.colorEditFlags ): infinity.ui.color

Parameters:

• label: string

  The label displayed next to the color edit widget.

• color: infinity.ui.color

  The initial or default color value presented in the widget.

• flags: infinity.ui.colorEditFlags, optional

  Flags to customize the behavior and appearance of the color edit widget.

Return type: infinity.ui.color

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.colorEdit(label, color);

colorPicker()¶

Creates a color picker UI widget that allows selection and modification of an infinity.ui.color value. Returns the chosen color in the infinity.ui.color format.

Signature:

colorPicker( label: string, color: infinity.ui.color, flags?: infinity.ui.colorEditFlags ): infinity.ui.color

Parameters:

• label: string

  The label displayed above the color picker widget.

• color: infinity.ui.color

  The initial or default color value presented in the picker.

• flags: infinity.ui.colorEditFlags, optional

  Flags to adjust the behavior and appearance of the color picker widget.

Return type: infinity.ui.color

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.colorPicker(label, color);

combo()¶

Creates a combo box UI widget that allows users to select from a drop-down list of items. Returns the index of the currently selected item.

Signature:

combo( label: string, currentItem: number, items: infinity.ui.stringArray, heightInItems?: number ): number

Parameters:

• label: string

  The label displayed next to the combo box.

• currentItem: number

  The index of the currently selected item from the items array.

• items: infinity.ui.stringArray

  An array of strings that represent the items in the drop-down list.

• heightInItems: number, optional

  The number of items to display in the combo's drop-down list before needing to scroll.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.combo(label, currentItem, items);

dragFloat()¶

Creates a draggable float slider UI widget. Returns the modified value after user interaction.

Signature:

dragFloat( label: string, v: number, speed?: number, vmin?: number, vmax?: number, format?: string, flags?: infinity.ui.sliderFlags ): number

Parameters:

• label: string

  The label displayed next to the float slider.

• v: number

  The current value of the float.

• speed: number, optional

  The increment/decrement speed when dragging.

• vmin: number, optional

  The minimum allowable value for the float.

• vmax: number, optional

  The maximum allowable value for the float.

• format: string, optional

  The format string used to display the float value. For example, "%.2f" will display the float with two decimal places.

• flags: infinity.ui.sliderFlags, optional

  Flags that customize the behavior of the slider.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.dragFloat(label, v);

dragInt()¶

Creates a draggable integer slider UI widget. Returns the modified value after user interaction.

Signature:

dragInt( label: string, v: number, speed?: number, vmin?: number, vmax?: number, format?: string, flags?: infinity.ui.sliderFlags ): number

Parameters:

• label: string

  The label displayed next to the integer slider.

• v: number

  The current value of the integer.

• speed: number, optional

  The increment/decrement speed when dragging.

• vmin: number, optional

  The minimum allowable value for the integer.

• vmax: number, optional

  The maximum allowable value for the integer.

• format: string, optional

  The format string used to display the integer value. For instance, "%d" would display the integer in decimal form.

• flags: infinity.ui.sliderFlags, optional

  Flags that customize the behavior of the slider.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.dragInt(label, v);

dummy()¶

Creates a blank space in the UI with specified dimensions.

Signature:

dummy( size: infinity.ui.vec2 ): void

Parameters:

• size: infinity.ui.vec2

  Specifies the width and height of the blank space.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.dummy(size);

end()¶

Closes the previously started window or container. Should be called after creating a window or a container (like begin, beginChild, etc.) to indicate its end.

Signature:

end(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.end();

endChild()¶

Closes the previously started child window or container. Should be called after creating a child window or a container using beginChild.

Signature:

endChild(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endChild();

endChildFrame()¶

Concludes the child frame initiated with beginChildFrame. Following the start of a child frame using beginChildFrame, use this function to properly terminate it.

Signature:

endChildFrame(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endChildFrame();

endCombo()¶

Concludes the combo box started with beginCombo.

Signature:

endCombo(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endCombo();

endDisabled()¶

Concludes the disabled UI state started with beginDisabled.

Signature:

endDisabled(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endDisabled();

endGroup()¶

Concludes the UI grouping started with beginGroup.

Signature:

endGroup(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endGroup();

endListBox()¶

Terminates the list box UI component started with beginListBox.

Signature:

endListBox(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endListBox();

endMainMenuBar()¶

Terminates the main menu bar UI component started with beginMainMenuBar.

Signature:

endMainMenuBar(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endMainMenuBar();

endMenu()¶

Terminates a menu UI component started with beginMenu.

Signature:

endMenu(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endMenu();

endMenuBar()¶

Terminates a menu bar UI component started with beginMenuBar.

Signature:

endMenuBar(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endMenuBar();

endPopup()¶

Terminates a popup UI component started with any of the beginPopup functions.

Signature:

endPopup(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endPopup();

endTabBar()¶

Closes an ongoing Tab Bar UI element initiated with beginTabBar.

Signature:

endTabBar(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endTabBar();

endTabItem()¶

Concludes an active Tab Item UI element initiated with beginTabItem.

Signature:

endTabItem(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endTabItem();

endTable()¶

Concludes an active Table UI element initiated with beginTable.

Signature:

endTable(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endTable();

endTooltip()¶

Concludes an active Tooltip UI element initiated with beginTooltip.

Signature:

endTooltip(): void

Example:

infinity.loadModule('infinity.ui');
infinity.ui.endTooltip();

freeTexture()¶

Releases a previously loaded texture from memory.

Signature:

freeTexture( texture: number ): boolean

Parameters:

• texture: number

  Specifies the unique identifier for the texture to be released.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.freeTexture(texture) ) {}

getClipboardText()¶

Retrieves the current text content from the system clipboard.

Signature:

getClipboardText(): string

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.getClipboardText();

getColor()¶

Fetches a color from the current style by index and multiplies its alpha by the provided factor.

Signature:

getColor( idx: infinity.ui.colorTypes, alphaMul: number ): number

Parameters:

• idx: infinity.ui.colorTypes

  A predefined color type that you want to use.

• alphaMul: number

  Factor by which the alpha value of the color is multiplied.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getColor(idx, alphaMul);

getColor()¶

Fetches a color based on its numeric representation.

Signature:

getColor( col: number ): number

Parameters:

• col: number

  Numeric representation of the color you want to fetch.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getColor(col);

getColor()¶

Fetches a color based on its RGBA representation.

Signature:

getColor( col: infinity.ui.color ): number

Parameters:

• col: infinity.ui.color

  The color you want to fetch, expressed in RGBA format.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getColor(col);

getContentRegionAvail()¶

Retrieves the size of the available content region within the current window or widget as an infinity.ui.vec2 object.

Signature:

getContentRegionAvail(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getContentRegionAvail();

getContentRegionMax()¶

Retrieves the maximum size of the content region within the current window or widget as an infinity.ui.vec2 object.

Signature:

getContentRegionMax(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getContentRegionMax();

getCursorPos()¶

Determines the current cursor position within the active window or widget and returns an infinity.ui.vec2 object representing the coordinates.

Signature:

getCursorPos(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getCursorPos();

getCursorPosX()¶

Determines the current cursor's X-coordinate within the active window or widget. Returns a number representing this X-coordinate.

Signature:

getCursorPosX(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getCursorPosX();

getCursorPosY()¶

Determines the current cursor's Y-coordinate within the active window or widget. Returns a number representing this Y-coordinate.

Signature:

getCursorPosY(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getCursorPosY();

getCursorScreenPos()¶

Determines the current cursor's Y-coordinate within the active window. Returns an infinity.ui.vec2 object representing this position.

Signature:

getCursorScreenPos(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getCursorScreenPos();

getCursorStartPos()¶

Retrieves the starting position of the cursor within the current window or widget. Returns an infinity.ui.vec2 object representing this position.

Signature:

getCursorStartPos(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getCursorStartPos();

getFont()¶

Retrieves the current font being used by the interface. Returns a numerical ID representing the font.

Signature:

getFont(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getFont();

getFontSize()¶

Retrieves the size of the current font being used by the interface. Returns a numerical value representing the font size in points.

Signature:

getFontSize(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getFontSize();

getFontTexUvWhitePixel()¶

Obtains the UV coordinates of a white pixel. Returns an infinity.ui.vec2 object representing the UV coordinates.

Signature:

getFontTexUvWhitePixel(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getFontTexUvWhitePixel();

getFrameCount()¶

Returns the current frame count since the start of the application.

Signature:

getFrameCount(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getFrameCount();

getFrameHeight()¶

Retrieves the height of a standard frame, commonly used in many widgets within the user interface. Returns a number indicating the height in pixels.

Signature:

getFrameHeight(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getFrameHeight();

getFrameHeightWithSpacing()¶

Retrieves the height of a standard frame, including the default spacing applied after it. Returns a number indicating the combined height in pixels.

Signature:

getFrameHeightWithSpacing(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getFrameHeightWithSpacing();

getId()¶

Generates a unique identifier for a UI element based on the provided string. Returns a number representing the generated ID.

Signature:

getId( id: string ): number

Parameters:

• id: string

  The name or label from which the unique ID will be generated.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getId(id);

getId()¶

Generates a unique identifier for a UI element based on a range denoted by two provided strings. Returns a number representing the generated ID.

Signature:

getId( idBegin: string, idEnd: string ): number

Parameters:

• idBegin: string

  The starting name or label of the range from which the unique ID will begin.

• idEnd: string

  The ending name or label of the range up to which the unique ID will be generated.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getId(idBegin, idEnd);

getItemRectMax()¶

Retrieves the maximum coordinate (bottom-right corner) of the last item that was drawn. Returns an infinity.ui.vec2 object representing the position of the bottom-right corner.

Signature:

getItemRectMax(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getItemRectMax();

getItemRectMin()¶

Retrieves the minimum coordinate (top-left corner) of the last item that was drawn. Returns an infinity.ui.vec2 object representing the position of the top-left corner. Signature:

getItemRectMin(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getItemRectMin();

getItemRectSize()¶

Retrieves the size of the last item that was drawn. Returns an infinity.ui.vec2 object representing the dimensions of the item.

Signature:

getItemRectSize(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getItemRectSize();

getKeyName()¶

Retrieves the human-readable name of the given key enumeration. Returns a string representing the key's name.

Signature:

getKeyName( key: infinity.ui.keys ): string

Parameters:

• key: infinity.ui.keys

  The keyboard key enumeration value for which the name is to be retrieved.

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.getKeyName(key);

getKeyPressedAmount()¶

Determines how many times a specific key has been pressed in succession within a defined time interval. Returns the count of key presses.

Signature:

getKeyPressedAmount( key: infinity.ui.keys, delay: number, rate: number ): number

Parameters:

• key: infinity.ui.keys

  The keyboard key enumeration value for which the pressed count is to be determined.

• delay: number

  The initial time delay (in seconds) before the key press repetition starts.

• rate: number

  The frequency (presses per second) at which the key repetition occurs after the initial delay.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getKeyPressedAmount(key, delay, rate);

getMouseClickedCount()¶

Retrieves the count of consecutive clicks for a specified mouse button within a short time frame. Returns the number of clicks registered.

Signature:

getMouseClickedCount( button: infinity.ui.mouseButtons ): number

Parameters:

• button: infinity.ui.mouseButtons

  The mouse button enumeration value for which the clicked count is to be determined.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getMouseClickedCount(button);

getMouseCursor()¶

Retrieves the current mouse cursor type. Returns the cursor type as one of the enumeration values from infinity.ui.mouseCursors

Signature:

getMouseCursor(): infinity.ui.mouseCursors

Return type: infinity.ui.mouseCursors

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getMouseCursor();

getMouseDragDelta()¶

Retrieves the delta distance the mouse has been dragged since the last call, given an optional specific button. The result is an infinity.ui.vec2 object representing the drag delta, where the x and y components indicate the horizontal and vertical distances, respectively.

Signature:

getMouseDragDelta( button?: infinity.ui.mouseButtons, lockThreshold?: number ): infinity.ui.vec2

Parameters:

• button: infinity.ui.mouseButtons, optional

  The specific mouse button to check. If not provided, it defaults to the left mouse button. This allows developers to determine the drag delta for any specific mouse button, be it left, right, or middle.

• lockThreshold: number, optional

  A threshold below which the mouse movement will be disregarded. It can be used to filter out minor jitters in mouse input.

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getMouseDragDelta();

getMousePos()¶

Retrieves the current position of the mouse cursor. The result is an infinity.ui.vec2 object representing the mouse's x and y coordinates on the screen.

Signature:

getMousePos(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getMousePos();

getMousePosOnOpeningCurrentPopup()¶

Retrieves the position of the mouse cursor when the current popup was opened. The returned value is an infinity.ui.vec2 object indicating the mouse's x and y coordinates at that moment.

Signature:

getMousePosOnOpeningCurrentPopup(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getMousePosOnOpeningCurrentPopup();

getStyleColor()¶

Retrieves the color value associated with a given style color type. The returned value is an infinity.ui.color object representing the RGBA color.

Signature:

getStyleColor( idx: infinity.ui.colorTypes ): infinity.ui.color

Parameters:

• idx: infinity.ui.colorTypes

  The style color type for which the value is being queried. This is an enumeration of various GUI elements and states (e.g., text, windowBg, buttonHovered) that have predefined color values in the UI's current theme.

Return type: infinity.ui.color

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getStyleColor(idx);

getStyleColorName()¶

Retrieves the name of a specified style color type as a string.

Signature:

getStyleColorName( index: infinity.ui.colorTypes ): string

Parameters:

• index: infinity.ui.colorTypes

  The style color type for which the name is being queried. This represents an enumeration of various GUI elements and states (e.g., text, windowBg, buttonHovered).

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.getStyleColorName(index);

getTextLineHeight()¶

Retrieves the height, in pixels, of a line of text for the current font.

Signature:

getTextLineHeight(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getTextLineHeight();

getTextLineHeightWithSpacing()¶

Retrieves and returns the height, in pixels, of a single line of text using the currently active font, along with any additional spacing.

Signature:

getTextLineHeightWithSpacing(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getTextLineHeightWithSpacing();

getTime()¶

Fetches and returns the time elapsed since the start of the application, in seconds.

Signature:

getTime(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getTime();

getTreeNodeToLabelSpacing()¶

Retrieves the horizontal spacing (in pixels) between a tree node and its label, allowing for precise placement of elements relative to tree node labels in user interface design.

Signature:

getTreeNodeToLabelSpacing(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getTreeNodeToLabelSpacing();

getWindowContentRegionMax()¶

Retrieves the maximum coordinates of the content region of the current window, returning an infinity.ui.vec2 object where the x and y components represent the maximum width and height, respectively.

Signature:

getWindowContentRegionMax(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getWindowContentRegionMax();

getWindowContentRegionMin()¶

Retrieves the minimum coordinates of the content region of the current window, returning an infinity.ui.vec2 object where the x and y components represent the minimum width and height, respectively.

Signature:

getWindowContentRegionMin(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getWindowContentRegionMin();

getWindowHeight()¶

Retrieves the height of the current window.

Signature:

getWindowHeight(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getWindowHeight();

getWindowPos()¶

Retrieves the position of the top-left corner of the current window, returning an object that represents its coordinates in pixels.

Signature:

getWindowPos(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getWindowPos();

getWindowSize()¶

Retrieves the size of the current window, returning an object containing its width and height in pixels.

Signature:

getWindowSize(): infinity.ui.vec2

Return type: infinity.ui.vec2

Example:

infinity.loadModule('infinity.ui');
let x = infinity.ui.getWindowSize();

getWindowWidth()¶

Retrieves the width of the current window in pixels.

Signature:

getWindowWidth(): number

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.getWindowWidth();

image()¶

Displays an image in the current UI context using the provided texture handle and size.

Signature:

image( texture: number, size: infinity.ui.vec2, uv1?: infinity.ui.vec2, uv2?: infinity.ui.vec2, tintCol?: infinity.ui.color, borderCol?: infinity.ui.color ): void

Parameters:

• texture: number

  A handle to the texture that you wish to display.

• size: infinity.ui.vec2

  An object specifying the width and height of the image to be displayed in pixels.

• uv1: infinity.ui.vec2, optional

  An object that denotes the top-left UV coordinate for texture mapping.

• uv2: infinity.ui.vec2, optional

  An object that denotes the bottom-right UV coordinate for texture mapping.

• tintCol: infinity.ui.color, optional

  An object representing the color to tint or modulate the image with.

• borderCol: infinity.ui.color, optional

  An object representing the color of the border.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.image(texture, size);

imageButton()¶

Renders an interactive image button in the current UI context using the provided texture handle and size. This button is clickable and returns a boolean value indicating if the button was pressed.

Signature:

imageButton( texture: number, size: infinity.ui.vec2, uv1?: infinity.ui.vec2, uv2?: infinity.ui.vec2, padding?: number, bgCol?: infinity.ui.color, tintCol?: infinity.ui.color ): boolean

Parameters:

• texture: number

  A handle to the texture that you wish to display on the button.

• size: infinity.ui.vec2

  An object specifying the width and height of the button to be displayed in pixels.

• uv1: infinity.ui.vec2, optional

  An object that denotes the top-left UV coordinate for texture mapping.

• uv2: infinity.ui.vec2, optional

  An object that denotes the bottom-right UV coordinate for texture mapping.

• padding: number, optional

  The amount of padding (in pixels) to be added around the image inside the button.

• bgCol: infinity.ui.color, optional

  An object representing the background color of the button.

• tintCol: infinity.ui.color, optional

  An object representing the color to tint or modulate the image with.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.imageButton(texture, size) ) {}

indent()¶

Shifts the current UI layout position to the right by a specified width, effectively creating an indentation.

Signature:

indent( width?: number ): void

Parameters:

• width: number, optional

  The amount of space (in pixels) to indent the content.

Example:

infinity.loadModule('infinity.ui');
infinity.ui.indent();

init()¶

Initializes a new UI window or element with the specified properties and position on the screen. The initialization can be controlled further using optional flags.

Signature:

init( caption: string, x: number, y: number, width: number, height: number, flags?: infinity.ui.initFlags ): boolean

Parameters:

• caption: string

  The title or label that will be displayed at the top of the window or element.

• x: number

  The horizontal position (in pixels) on the screen where the window's or element's left edge will be placed.

• y: number

  The vertical position (in pixels) on the screen where the window's or element's top edge will be placed.

• width: number

  The width (in pixels) of the window or element.

• height: number

  The height (in pixels) of the window or element.

• flags: infinity.ui.initFlags, optional

  Flags that control various initialization behaviors and properties for the window or element.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.init(caption, x, y, width, height) ) {}

inputFloat()¶

Displays an input box for floating-point values, allowing users to increment or enter a numerical value. The appearance and behavior of the input box can be further customized with optional parameters. Returns a boolean value indicating whether the initialization was successful.

Signature:

inputFloat( label: string, v: number, step?: number, stepFast?: number, format?: string, flags?: infinity.ui.inputTextFlags ): number

Parameters:

• label: string

  The text label associated with the input box.

• v: number

  The initial value displayed in the input box.

• step: number, optional

  The amount by which the value will increase or decrease when using the default stepping buttons.

• stepFast: number, optional

  The amount by which the value will quickly increase or decrease, typically when a modifier key is held down.

• format: string, optional

  A string that dictates how the number will be formatted within the input box (e.g., "%.2f" for two decimal places).

• flags: infinity.ui.inputTextFlags, optional

  Flags that modify the behavior or appearance of the input box. If not specified, default behaviors are applied.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.inputFloat(label, v);

inputInt()¶

Displays an input box for floating-point values, allowing users to increment or enter a numerical value. The appearance and behavior of the input box can be further customized with optional parameters. Returns the modified value entered by the user or the initial value if no changes were made. Returns the updated value input by the user, or the original value if no changes occurred.

Signature:

inputInt( label: string, v: number, step?: number, stepFast?: number, flags?: infinity.ui.inputTextFlags ): number

Parameters:

• label: string

  The text label that accompanies the input box.

• v: number

  The initial whole number presented in the input box.

• step: number, optional

  The amount the value will change when using the default increment and decrement buttons.

• stepFast: number, optional

  The larger increment or decrement amount typically activated when a modifier key is held down.

• flags: infinity.ui.inputTextFlags, optional

  Flags to alter the behavior or visual presentation of the input box.

Return type: number

Example:

infinity.loadModule('infinity.ui');
let n = infinity.ui.inputInt(label, v);

inputText()¶

Displays an input box for text values, allowing users to type or edit a string. The behavior and appearance of the input box can be adjusted using the optional parameters. Returns the updated string input by the user, or the original string if no changes occurred.

Signature:

inputText( label: string, text: string, flags?: infinity.ui.inputTextFlags ): string

Parameters:

• label: string

  The text label that accompanies the input box.

• text: string

  The initial string presented in the input box.

• flags: infinity.ui.inputTextFlags, optional

  Flags that modify the behavior or visual presentation of the input box.

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.inputText(label, text);

inputTextMultiline()¶

Displays a multi-line input box for text values, offering an expanded area for users to type or edit a string across multiple lines. The behavior and appearance of this input box can be further customized using the optional parameters. Returns the revised multi-line string input by the user, or the original string if there were no changes.

Signature:

inputTextMultiline( label: string, text: string, size?: infinity.ui.vec2, flags?: infinity.ui.inputTextFlags ): string

Parameters:

• label: string

  The text label displayed alongside the multi-line input box.

• text: string

  The initial string presented within the multi-line input space.

• size: infinity.ui.vec2, optional

  Specifies the dimensions of the input box as an object with x (width) and y (height) components.

• flags: infinity.ui.inputTextFlags, optional

  Flags influencing the behavior or visual style of the input box.

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.inputTextMultiline(label, text);

inputTextWithHint()¶

Displays an input box for text values, featuring a hint that provides guidance or context to the user about the expected input. The hint disappears when the user starts typing and the actual value of the input box becomes the main focus. Additional characteristics of the input box can be modified using the optional flags.

Signature:

inputTextWithHint( label: string, hint: string, text: string, flags?: infinity.ui.inputTextFlags ): string

Parameters:

• label: string

  The text label displayed alongside the input box.

• hint: string

  The subtle text displayed within the input box to guide the user on the expected input.

• text: string

  The initial string shown within the input space.

• flags: infinity.ui.inputTextFlags, optional

  Flags that adjust the behavior or visual representation of the input box.

Return type: string

Example:

infinity.loadModule('infinity.ui');
let s = infinity.ui.inputTextWithHint(label, hint, text);

invisibleButton()¶

Creates an invisible button, occupying space as defined by the size parameter but without any visual representation, making it useful for custom behavior or layouts. It's often used for custom hit detection areas or to override standard UI behaviors. The button's state can be identified through the return value.

Signature:

invisibleButton( id: string, size: infinity.ui.vec2, flags?: infinity.ui.buttonFlags ): boolean

Parameters:

• id: string

  The unique identifier for this button, ensuring interactions with it are distinct from other UI elements.

• size: infinity.ui.vec2

  An object representing the width and height of the button in pixels.

• flags: infinity.ui.buttonFlags, optional

  Flags that adjust the behavior or visual representation of the button.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.invisibleButton(id, size) ) {}

isAnyItemActive()¶

Determines and returns true if any user interface (UI) item is currently active or in focus. This is useful to check if there's ongoing interaction with any part of the UI.

Signature:

isAnyItemActive(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isAnyItemActive() ) {}

isAnyItemFocused()¶

Determines and returns true if any user interface (UI) item currently has input focus. This can be used to ascertain if any part of the UI is awaiting or actively processing user input.

Signature:

isAnyItemFocused(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isAnyItemFocused() ) {}

isAnyItemHovered()¶

Determines whether the mouse cursor is currently hovering over any user interface (UI) item.

Signature:

isAnyItemHovered(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isAnyItemHovered() ) {}

isAnyMouseDown()¶

Checks and returns true if any mouse button is currently being pressed.

Signature:

isAnyMouseDown(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isAnyMouseDown() ) {}

isItemActivated()¶

Determines and returns true if the last item was activated, typically by a mouse click or a key equivalent.

Signature:

isItemActivated(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemActivated() ) {}

isItemActive()¶

Checks if the last item is currently active.

Signature:

isItemActive(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemActive() ) {}

isItemClicked()¶

Determines if the last item was clicked with the specified mouse button.

Signature:

isItemClicked( button?: infinity.ui.mouseButtons ): boolean

Parameters:

• button: infinity.ui.mouseButtons, optional

  Specifies the mouse button to check.

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemClicked() ) {}

isItemDeactivated()¶

Determines if the last active item has just been deactivated.

Signature:

isItemDeactivated(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemDeactivated() ) {}

isItemDeactivatedAfterEdit()¶

Determines if the currently processed item was deactivated after a value edit.

Signature:

isItemDeactivatedAfterEdit(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemDeactivatedAfterEdit() ) {}

isItemEdited()¶

Checks if the currently processed item's value has been modified.

Signature:

isItemEdited(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemEdited() ) {}

isItemFocused()¶

Checks whether the currently processed item has input focus.

Signature:

isItemFocused(): boolean

Return type: boolean

Example:

infinity.loadModule('infinity.ui');
if ( infinity.ui.isItemFocused() ) {}

isItemHovered()¶

Determines whether the currently processed item is being hovered over, taking optional hoveredFlags into account.

Signature:

isItemHovered( flags?: infinity.ui.hoveredFlags ): boolean

Parameters:

• flags: infinity.ui.hoveredFlags, optional

  Specific conditions to consider when checking for hovering, using the infinity.ui.hoveredFlags enumeration.