Skip to main content

IconAtlasOptionsAlpha

Icon atlas options only relevant for icons where icon alpha is used for opacity

Hierarchy

Index

Properties

Properties

optionalalphaSortIntervalInMs

alphaSortIntervalInMs?: number

If specified alpha sorting occurs at this interval (in ms). If 0 alpha sorting occurs on every rendered frame. This is expensive Defaults to 500ms if not specified.

hasAlpha

hasAlpha: true

Texture atlas contains alpha, all the icons will be alpha sorted at interval specified by alphaSortIntervalInMs. It is very expensive to alpha sort icons so use with care and try not to use too many icons. The more there are the more expensive the sort operation will become. Framerate and navigation will degrade quickly. How much depends on how powerful the device running the code is.

iconAtlasTexture

iconAtlasTexture: Texture

Power of 2 texture, containing squared icons in grayscale or color. You can use getTexture to load texture from URL.

optionaliconMaxSize

iconMaxSize?: number

Set the maximum size a icon can have. If not specified default is 16. Each icon can scale this value down by setting Icon.size to a skale between 0-1

numberOfIconsInAStyle

numberOfIconsInAStyle: number

The number of different icon in the same style. All icons in the set needs to have the same amount of style variations.

optionalocclusionCullingIntervalMs

occlusionCullingIntervalMs?: number

If specified occlusion culling occurs at this interval in ms. If 0 occlusion culling occurs on every frame (very expensive)

totalNumberOfIconsAndStyles

totalNumberOfIconsAndStyles: number

E.g in a texture with 4 X 4 icons, the total amount is 16

Page Options