ShivaVG

See AUTHORS for the list of contributors

ShivaVG is an open-source LGPL ANSI C implementation of the Khronos Group OpenVG specification.

I. BUILD

II. TESTING

III. IMPLEMENTATION STATUS

IV. EXTENSIONS

I. BUILD

Prerequisites

OpenGL development libraries and headers should be installed. Other than that, since it's ANSI C should compile with any modern C compiler. jpeglib needs to be installed for example programs that use images.

Compiling

ShivaVG has now been converted to CMake.

To compile it, obtain CMake from its website, generate project files for your favorite build system or IDE.
It is advisable to do so in a separate build directory to keep things clean.

$ mkdir build; cd build

For example using Make: cmake .. -G "Unix Makefiles" && make

Xcode/OS X: $ cmake .. -G Xcode && xcodebuild

For Windows, generate Visual Studio project files with the CMake GUI.

Static Analysis

To run the Clang Static Analyzer with CMake, obtain the latest analyzer from its website and unpack it somewhere.
Also, unless you have a file called ccc-analyzer directly in your checker-xyz directory, obtain it here. (It has to be executable (chmod +x) as well.)

To tell CMake to use the Analyzer and check the code, do

$ cmake -DCMAKE_C_COMPILER=YOUR-PATH-TO-checker-xyz/ccc-analyzer -G "Unix Makefiles"
$ checker-xyz/scan-build make

II. TESTING

There is no real testing suite yet. The example programs are there just to play with what the implementation can currently do, but can hardly provide any proper validation, since no reference images are provided. Here is a description of each example program and what features it highlights:

• test_vgu
  Constructs some path primitives using the VGU API.

• test_tiger
  The most simple performance test. It draws the well known svg tiger using just simple stroke and fill of solid colors. It consists of 240 paths.

• test_dash
  Shows different stroke dashing modes.

• test_linear
  A rectangle drawn using 3-color linear gradient fill paint

• test_radial
  A rectangle drawn using 3-color radial gradient fill paint

• test_interpolate
  Interpolates between two paths - an apple and a pear.

• test_image
  Images are drawn using VG_DRAW_IMAGE_MULTIPLY image mode to be multiplied with radial gradient fill paint.

• test_pattern
  An image is drawn in multiply mode with an image pattern fill paint.

III. IMPLEMENTATION STATUS

Khronos states in the OpenVG specification, that the contexts for all their client APIs are expected to be created via the EGL API. Since EGL to use with ShivaVG has not been implemented yet, there is a set of extension functions provided for the task of creating, maintaining and destroying the OpenVG context. (See next section EXTENSIONS for details.)

What follows is a description of which functions or to what extent a certain function has been implemented. When a function is marked as PARTIALLY implemented, the TODO file or the comments in the code itself would provide further clues.

• General:

vgGetError ............................ FULLY implemented
vgFlush ............................... FULLY implemented
vgFinish .............................. FULLY implemented

• Getters and setters:

vgSet ................................. FULLY implemented
vgSeti ................................ FULLY implemented
vgSetfv ............................... FULLY implemented
vgSetiv ............................... FULLY implemented
vgGetf ................................ FULLY implemented
vgGeti ................................ FULLY implemented
vgGetVectorSize ....................... FULLY implemented
vgGetfv ............................... FULLY implemented
vgGetiv ............................... FULLY implemented
vgSetParameterf ....................... FULLY implemented
vgSetParameteri ....................... FULLY implemented
vgSetParameterfv ...................... FULLY implemented
vgSetParameteriv ...................... FULLY implemented
vgGetParameterf ....................... FULLY implemented
vgGetParameteri ....................... FULLY implemented
vgGetParameterVectorSize............... FULLY implemented
vgGetParameterfv ...................... FULLY implemented
vgGetParameteriv ...................... FULLY implemented

• Matrix Manipulation:

vgLoadIdentity ........................ FULLY implemented
vgLoadMatrix .......................... FULLY implemented
vgGetMatrix ........................... FULLY implemented
vgMultMatrix .......................... FULLY implemented
vgTranslate ........................... FULLY implemented
vgScale ............................... FULLY implemented
vgShear ............................... FULLY implemented
vgRotate .............................. FULLY implemented

• Masking and Clearing:

vgMask ................................ NOT implemented
vgClear ............................... FULLY implemented

• Paths:

vgCreatePath .......................... FULLY implemented
vgClearPath ........................... FULLY implemented
vgDestroyPath ......................... FULLY implemented
vgRemovePathCapabilities .............. FULLY implemented
vgGetPathCapabilities ................. FULLY implemented
vgAppendPath .......................... FULLY implemented
vgAppendPathData ...................... FULLY implemented
vgModifyPathCoords .................... FULLY implemented
vgTransformPath ....................... FULLY implemented
vgInterpolatePath ..................... FULLY implemented
vgPathLength .......................... FULLY implemented
vgPointAlongPath ...................... NOT implemented
vgPathBounds .......................... FULLY implemented
vgPathTransformedBounds ............... FULLY implemented
vgDrawPath ............................ PARTIALLY implemented

• Paint:

vgCreatePaint ......................... FULLY implemented
vgDestroyPaint ........................ FULLY implemented
vgSetPaint ............................ FULLY implemented
vgGetPaint ............................ FULLY implemented
vgSetColor ............................ FULLY implemented
vgGetColor ............................ FULLY implemented
vgPaintPattern ........................ FULLY implemented

• Images:

vgCreateImage ......................... PARTIALLY implemented
vgDestroyImage ........................ FULLY implemented
vgClearImage .......................... FULLY implemented
vgImageSubData ........................ PARTIALLY implemented
vgGetImageSubData ..................... PARTIALLY implemented
vgChildImage .......................... NOT implemented
vgGetParent ........................... NOT implemented
vgCopyImage ........................... FULLY implemented
vgDrawImage ........................... PARTIALLY implemented
vgSetPixels ........................... FULLY implemented
vgWritePixels ......................... FULLY implemented
vgGetPixels ........................... FULLY implemented
vgReadPixels .......................... FULLY implemented
vgCopyPixels .......................... FULLY implemented

• Image Filters:

vgColorMatrix ......................... NOT implemented
vgConvolve ............................ NOT implemented
vgSeparableConvolve ................... NOT implemented
vgGaussianBlur ........................ NOT implemented
vgLookup .............................. NOT implemented
vgLookupSingle ........................ NOT implemented

• Hardware Queries:

vgHardwareQuery ....................... NOT implemented

• Renderer and Extension Information:

vgGetString ........................... FULLY implemented

• VGU

vguLine ............................... FULLY implemented
vguPolygon ............................ FULLY implemented
vguRect ............................... FULLY implemented
vguRoundRect .......................... FULLY implemented
vguEllipse ............................ FULLY implemented
vguArc ................................ FULLY implemented
vguComputeWarpQuadToSquare ............ NOT implemented
vguComputeWarpSquareToQuad ............ NOT implemented
vguComputeWarpQuadToQuad .............. NOT implemented

IV. EXTENSIONS

There are three extensions to the API that manipulate the OpenVG context as a temporary replacement for EGL:

• VGboolean vgCreateContextSH(VGint width, VGint height)
  Creates an OpenVG context on top of an existing OpenGL context that should have been manually initialized by the user of the library. Width and height specify the size of the rendering surface. No multi-threading support has been implemented yet. The context is created once per process.

• void vgResizeSurfaceSH(VGint width, VGint height)
  Should be called whenever the size of the surface changes (e.g. the owner window of the OpenGL context is resized).

• void vgDestroyContextSH()
  Destroys the OpenVG context associated with the calling process.