Index

C/C++ Functions

pdDocSetFilter

DT_SWORD pdDocSetFilter(DT_PDDOC power_doc, DT_SWORD reserved, DT_ULONG filter)

Short Description: Set visibility filter

The pdDocSetFilter function applies the visibility filter to any text output generated by D-Type Power Engine. This filter disables the display of the shadow, body, outline and/or underline layers when D-Type Power Engine renders text. By default, the visibility filter is off, meaning that all four layers (shadow, body, outline, underline) are visible when D-Type Power Engine renders text.

Parameters

ParameterDescription

power_doc

Handle of the associated Power Engine document.

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 Power Engine renders text.

  • Bit 0: If set (1), the shadow layer is not visible. If unset (0), the shadow layer is visible.
  • Bit 1: If set (1), the body layer is not visible. If unset (0), the body layer is visible.
  • Bit 2: If set (1), the outline layer is not visible. If unset (0), the outline layer is visible.
  • Bit 3: If set (1), the underline / strike-through layer is not visible. If unset (0), the underline / strike-through layer is visible.

Return Value

If successful, the return value is 1. Otherwise, the function returns 0.

Related Functions

pdDocGetFilter

Comments

The following table illustrates the effect of the visibility filter on text output.

Filter ValueResulting Output
(0) 0000 Filter=000
(1) 0001 Filter=001
(2) 0010 Filter=010
(3) 0011 Filter=011
(4) 0100 Filter=100
(5) 0101 Filter=101
(6) 0110 Filter=110
(7) 0111 Filter=111
 

Index