Class BabylonGuiImage

Images shown as GUI controls, loaded from a URL, for logos, icons and pictures beside other controls.

Index

Constructors

create

get

set

Constructors

constructor

new BabylonGuiImage(): BabylonGuiImage
Returns BabylonGuiImage

create

createImage

createImage(inputs: CreateImageDto): Image
Creates an image control that loads its picture from url; sizes are pixel strings or fractions of the parent, and a size left out is chosen by the engine.
Parameters
- inputs: CreateImageDto
  The name, the URL, the color and the optional size
Returns Image
The image control
Example
```
const logo = bitbybit.babylon.gui.image.createImage({ name: "logo", url: "https://example.com/logo.png", color: "black", width: "120px", height: "60px" });
panel.addControl(logo);
```
- Defined in bitbybit-docs.d.ts:49222

get

getSourceUrl

getSourceUrl(inputs: ImageDto): string
Reads the URL an image control loads its picture from.
Parameters
- inputs: ImageDto
  The image control
Returns string
The URL
- Defined in bitbybit-docs.d.ts:49238

set

setSourceUrl

setSourceUrl(inputs: SetImageUrlDto): Image
Changes the picture an image control shows by giving it a new URL to load.
Parameters
- inputs: SetImageUrlDto
  The image control and the URL
Returns Image
The same image control
- Defined in bitbybit-docs.d.ts:49230