SkAnnotation.h File Reference

#include "include/core/SkTypes.h"

Go to the source code of this file.

Functions
SK_API void	SkAnnotateRectWithURL (SkCanvas *, const SkRect &, SkData *)
SK_API void	SkAnnotateNamedDestination (SkCanvas *, const SkPoint &, SkData *)
SK_API void	SkAnnotateLinkToDestination (SkCanvas *, const SkRect &, SkData *)

Function Documentation

SkAnnotateLinkToDestination()

SK_API void SkAnnotateLinkToDestination	(	SkCanvas *	canvas,
		const SkRect &	rect,
		SkData *	name
	)

Annotate the canvas by making the specified rectangle link to a named destination.

If the backend of this canvas does not support annotations, this call is safely ignored.

The caller is responsible for managing its ownership of the SkData.

Definition at line 43 of file SkAnnotation.cpp.

                                                                                     {
    if (nullptr == name) {
        return;
    }
    canvas->drawAnnotation(rect, SkAnnotationKeys::Link_Named_Dest_Key(), name);
}

SkAnnotateNamedDestination()

SK_API void SkAnnotateNamedDestination	(	SkCanvas *	canvas,
		const SkPoint &	point,
		SkData *	name
	)

Annotate the canvas by associating a name with the specified point.

If the backend of this canvas does not support annotations, this call is safely ignored.

The caller is responsible for managing its ownership of the SkData.

Definition at line 35 of file SkAnnotation.cpp.

                                                                                      {
    if (nullptr == name) {
        return;
    }
    const SkRect rect = SkRect::MakeXYWH(point.x(), point.y(), 0, 0);
    canvas->drawAnnotation(rect, SkAnnotationKeys::Define_Named_Dest_Key(), name);
}

SkAnnotateRectWithURL()

SK_API void SkAnnotateRectWithURL	(	SkCanvas *	canvas,
		const SkRect &	rect,
		SkData *	value
	)

Annotate the canvas by associating the specified URL with the specified rectangle (in local coordinates, just like drawRect).

The URL is expected to be escaped and be valid 7-bit ASCII.

If the backend of this canvas does not support annotations, this call is safely ignored.

The caller is responsible for managing its ownership of the SkData.

Definition at line 28 of file SkAnnotation.cpp.

                                                                                {
    if (nullptr == value) {
        return;
    }
    canvas->drawAnnotation(rect, SkAnnotationKeys::URL_Key(), value);
}