XRVisibilityMaskChangeEvent: vertices property

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only vertices property of the XRVisibilityMaskChangeEvent interface is an array representing all the coordinate values that may be used in the visibility mask. If this array is empty, the whole region of the XRView will be drawn.

Value

A Float32Array.

Description

Each pair of values available in the vertices array represents the x and y coordinate values of a point on a flat mask in clip space. So for example, a simple square mask might be represented by the following array:

[0, 0, 0, 1, 1, 1, 1, 0]

which represents the x,y coordinates (0,0), (0,1), (1,1), and (1,0). These coordinates the boundary of the visibility mask — the region of the display that is actually visible to the user. Anything outside the mask is not visible to the user, and does not need to be drawn. It can be skipped to improve performance.

The indices array specifies the index position of each coordinate pair (not individual array index) inside the vertices array that define the triangles used to draw the currently visible part of the scene displayed in the XRView. The number of contained values should therefore be a multiple of three. A sample indices array related to the above vertices example might looks like this:

[0,1,2,0,3,2]

Which represent two triangles represented by coordinate pairs 0, 1, and 2, and 0, 3, and 2, which can be used to create a basic mesh. The vertices and indices arrays are designed to be passed to a graphics library.

Examples

See the main XRVisibilityMaskChangeEvent page for an example.

Specifications

Specification
WebXR Device API
# dom-xrvisibilitymaskchangeevent-vertices

Browser compatibility

See also