L_AnnGetROP2 - Raster Imaging C API Help

L_AnnGetROP2

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetROP2(hObject, puRop2)

HANNOBJECT hObject;

handle to the annotation object

L_UINT *puRop2;

address of the variable to be updated

Gets a constant that indicates which binary raster operation (ROP2) code is being used for one or more objects.

Parameter Description
hObject Handle to the annotation object.
puRop2 Address of the variable to be updated with the ROP2 code. Possible ROP2 code values are:
  Value Meaning
  ANNROP2_COPY [0x0000] Draw the object using the object's color
  ANNROP2_AND [0x0001] Draw the object, performing an AND operation between the object's color and the background color. This creates a highlight effect. White objects become transparent.
  ANNROP2_XOR [0x0002]Draw the object, performing an XOR operation between the object's color and the background color. This creates an inverted effect. Black objects become transparent.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The ROP2 code for the object is retrieved and stored in the memory location indicated by puROP2.

ROP2 codes specify how pen or brush colors are to be combined with the colors in the image.

The L_AnnGetROP2 function is valid only for the following object types:

Crossproduct

Curve

Closed Curve

Ellipse

Freehand

Freehand Hotspot

Line

Pointer

Point

Polygon

Polyline

Polyruler

Protractor

Rectangle

Ruler

Stamp (including the Rubber Stamp)

TextPointer

In addition, the Automation object stores ROP2 settings along with the other object default settings

If you try to use the L_AnnGetROP2 function with an object that does not support it, the function returns Error (-16), which is "Feature not supported".

Call the L_AnnSetROP2 function to set the ROP2 code being used for one or more annotation objects.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help