The txTextSetFilter function applies the visibility filter to any text output generated by D-Type Unicode Text Module. This filter disables the display of the shadow, body, outline and/or underline layers when D-Type Unicode Text Module renders text. By default, the visibility filter is off, meaning that all four layers (shadow, body, outline, underline) are visible when D-Type Unicode Text Module renders text.
This is a convenience function. It has the same effect as the following code:
DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc); pdDocSetFilter(power_doc, reserved, filter);
Parameter | Description |
---|---|
text_doc |
Handle of the associated text document instance. |
reserved |
Reserved for future use. Must be set to 0. |
filter |
Visibility filter. This value is a combination of three independent bit values which indicate which of the four layers (shadow, body, outline, underline) will be suppressed when D-Type Unicode Text Module renders text.
|
If successful, the return value is 1. Otherwise, the function returns 0.
The following table illustrates the effect of the visibility filter on text output.
Filter Value | Resulting Output |
---|---|
(0) 0000 | ![]() |
(1) 0001 | ![]() |
(2) 0010 | ![]() |
(3) 0011 | ![]() |
(4) 0100 | ![]() |
(5) 0101 | ![]() |
(6) 0110 | ![]() |
(7) 0111 | ![]() |