Main| Guide| API| GitHub| Wiki| FAQ

B.Render.MultisampleState()

Represent a multisampling rendering state.

To get the object use pass.state(B.Render.State.MULTISAMPLE).

TYPES:

Coverage

Describes multisample coverage parameters.

{number} value

a floating-point sample coverage value (clamped to [0, 1])

{boolean} invert

a boolean value representing if the coverage masks should be inverted

METHODS:

pass()

Returns linked pass.

RETURNS:

{B.Render.Pass}

default()

Resets to default values.

// equivalent to
state.coverage(false);
state.alpha(false);

RETURNS:

{B.Render.MultisampleState}

this

coverage(value)

Sets multisample coverage.

PARAMETERS:

{B.Render.MultisampleState~Coverage | false} value

pass false to disable multisample coverage

RETURNS:

{B.Render.MultisampleState}

this

coverage(value, invert)

Sets multisample coverage parameters.

PARAMETERS:

{number} value

a floating-point sample coverage value (clamped to range [0, 1])

{boolean} invert

a boolean value representing if the coverage masks should be inverted

RETURNS:

{B.Render.MultisampleState}

this

coverage()

Returns multisample coverage parameters.

RETURNS:

{B.Render.MultisampleState~Coverage | false}

false if multisample coverage is disabled

alpha(enable)

Sets alpha to coverage enable.

PARAMETERS:

{boolean} enable

RETURNS:

{B.Render.MultisampleState}

this

alpha()

Gets alpha to coverage enable.

RETURNS:

{boolean}

TYPES:

METHODS: