official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: BlendMode

X3DOM
Component: Shape

Quick Links

➨ Fields
➨ Properties

.nodeTypes. BlendMode

The BlendMode controls blending and alpha test. Pixels can be drawn using a function that blends the incoming (source) RGBA values with the RGBA values that are already in the frame buffer (the destination values).

HTML Encoding and Default Values⤴

<BlendMode alphaFunc='"none"' alphaFuncValue='0' color='1,1,1' colorTransparency='0' destFactor='"one_minus_src_alpha"' equation='"none"' metadata='X3DMetadataObject' srcFactor='"src_alpha"' ></BlendMode>

Inheritance⤴


Constructor⤴

BlendMode(ctx)⤴

Constructor for BlendMode

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
alphaFunc SFString "none"
alphaFuncValue SFFloat 0 [none, never, less, equal, lequal, greater, notequal, gequal, always] The alphaFunc defines how fragments which do not fulfill a certain condition are handled.
color SFColor 1,1,1 This is the constant color used by blend modes constant.
colorTransparency SFFloat 0 This is the constant alpha used by blend modes constant.
destFactor SFString "one_minus_src_alpha" [none, zero, one, dst_color, src_color, one_minus_dst_color, one_minus_src_color, src_alpha, one_minus_src_alpha, dst_alpha, one_minus_dst_alpha, src_alpha_saturate, constant_color, one_minus_constant_color, constant_alpha, one_minus_constant_alpha] The frame buffer pixel is scaled according to the method defined by the destination factor.
equation SFString "none" [none, func_add, func_subtract, func_reverse_subtract, min, max, logic_op] An additional equation used to combine source, destination and the constant value.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
srcFactor SFString "src_alpha" [none, zero, one, dst_color, src_color, one_minus_dst_color, one_minus_src_color, src_alpha, one_minus_src_alpha, dst_alpha, one_minus_dst_alpha, src_alpha_saturate, constant_color, one_minus_constant_color, constant_alpha, one_minus_constant_alpha] The incoming pixel is scaled according to the method defined by the source factor.