screenDepth

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
the screenDepth
screenDepth()
Summary

Returns the bit depth of the screen.

Introduced1.0
OSmac, windows, linux
Platformsdesktop, server
Example
the screenDepth
if the screenDepth > 8 then show image "Photograph"
Values
NameTypeDescription
return

The screenDepth function returns 0, 1, 2, 4, 8, 16, 24, or 32.

RelatedProperty: colorWorld, dontDither
Glossary: bit depth, return, application
Command: unlock colorMap
Object: image
Function: environment, screenType
Control Structure: function
Description

Use the screenDepth function to determine the color capacity of the screen. For example, you might display different images depending on the number of colors available.

If the system has more than one monitor, the screenDepth function returns the bit depth of the main screen.

The expression

2 ^ (the screenDepth)

is equal to

the screenColors

The value returned by the screenDepth function is updated only when you start up the application. If you change the screen settings after starting up the application, you must quit and restart to update the screenDepth.

When the environment is "command line", the screenDepth is 0.