RenderConfig

View source
clay.RenderConfig (Class)

Config specific to the rendering context that would be used when creating windows

Instance Members

depth: Int

Request the number of depth bits for the rendering context. A value of 0 will not request a depth buffer. default: 0

stencil: Int

Request the number of stencil bits for the rendering context. A value of 0 will not request a stencil buffer. default: 0

antialiasing: Int

A value of 0, 2, 4, 8 or other valid system value. On WebGL contexts this value is true or false, bigger than 0 being true. On native contexts this value sets the MSAA typically. default webgl: 1 (enabled) default: 0

redBits: Int

Request a specific number of red bits for the rendering context. Unless you need to change this, don't. default: 8

greenBits: Int

Request a specific number of green bits for the rendering context. Unless you need to change this, don't. default: 8

blueBits: Int

Request a specific number of blue bits for the rendering context. Unless you need to change this, don't. default: 8

alphaBits: Int

Request a specific number of alpha bits for the rendering context. Unless you need to change this, don't. default: 8

defaultClear: clay.graphics.Color

A color value that when creating the window, the window backbuffer will be cleared to. A framework above clay can also use this for default clear color if desired. The values are specified as 0..1. default: black, 0,0,0,1

vsync: Bool

If applicable on the current platform, enables vsync

WebGL render context specific settings

new(?depth: Null<Int>, ?stencil: Null<Int>, ?antialiasing: Null<Int>, ?redBits: Null<Int>, ?greenBits: Null<Int>, ?blueBits: Null<Int>, ?alphaBits: Null<Int>, ?defaultClear: Null<clay.graphics.Color>, ?vsync: Null<Bool>, ?webgl: Null<RenderConfigWebGL>): Void
Name Type Default Description
depth Null<Int> (optional) Request the number of depth bits for the rendering context. A value of 0 will not request a depth buffer. default: 0
stencil Null<Int> (optional) Request the number of stencil bits for the rendering context. A value of 0 will not request a stencil buffer. default: 0
antialiasing Null<Int> (optional) A value of 0, 2, 4, 8 or other valid system value. On WebGL contexts this value is true or false, bigger than 0 being true. On native contexts this value sets the MSAA typically. default webgl: 1 (enabled) default: 0
redBits Null<Int> (optional) Request a specific number of red bits for the rendering context. Unless you need to change this, don't. default: 8
greenBits Null<Int> (optional) Request a specific number of green bits for the rendering context. Unless you need to change this, don't. default: 8
blueBits Null<Int> (optional) Request a specific number of blue bits for the rendering context. Unless you need to change this, don't. default: 8
alphaBits Null<Int> (optional) Request a specific number of alpha bits for the rendering context. Unless you need to change this, don't. default: 8
defaultClear Null<clay.graphics.Color> (optional) A color value that when creating the window, the window backbuffer will be cleared to. A framework above clay can also use this for default clear color if desired. The values are specified as 0..1. default: black, 0,0,0,1
vsync Null<Bool> (optional) If applicable on the current platform, enables vsync
webgl Null<RenderConfigWebGL> (optional) WebGL render context specific settings

Metadata

Name Parameters
:structInit -
:publicFields -