Link Search Menu Expand Document

πŸ– Bitmask

PCGEx | Filter : Bitmask

Checks specific flags in an int64 bitmask attribute with configurable mask types, comparisons, and an option to invert results.

-


Filter
A single filter definition

Table of content


The Bitmask Filter lets you check whether certain flags are set or not in an int64 bitmask attribute.

details/filter-ecosystem/filter-bitmask-lead.png


Properties


Property Description
Flags Attributes The is the name of the attribtue which value will be tested.
It is expected to be an int64.
Mask Type Type of source mask. Can be a per-point Attribute, or an easily overridable Constant.
Comparison See Bitmask comparisons.
Bitmask
(Constant or Attribute)
Mask value.
Strictly expects an int64.
Invert Result If enabled, invert the result of the filter.

Comparison modes


Comparison Data
Match (any) Value & Mask != 0 (At least some flags in the mask are set)
Match (all) Value & Mask == Mask (All the flags in the mask are set)
Match (strict) Value == Mask (Flags strictly equals mask)
No Match (any) Value & Mask == 0 (Flags does not contains any from mask)
No Match (all) Value & Mask != Mask (Flags does not contains the mask)