EyeQ Docs
Api reference

API Reference

Complete API reference for the Perfectly Clear SDK, covering C, .NET, and Java interfaces.

The Perfectly Clear SDK provides multiple interfaces for integrating image correction capabilities into your applications.

C API

The native C library defined in PerfectlyClearPro.h provides the core SDK functionality and is the primary interface used across all platforms including Linux, macOS, and Windows.

  • Functions — Core functions for image correction, engine management, and analysis
  • Enums — Enumerations for pixel formats, correction modes, and status codes
  • Structs — Parameter structures for configuring corrections
  • Error Codes — Status codes and decode macros for error handling

.NET API

The .NET wrapper defined in PerfectlyClearAdapter.cs provides a managed interface for Windows development using C#, with function names and calling patterns that closely mirror the C API.

  • Overview — .NET API overview and quick start
  • Classes — Main classes and their methods
  • Error Handling — Patterns for handling errors in .NET
  • Exceptions — Exception types thrown by the SDK

Java (JNI) API

The JNI wrapper provides Java bindings for server-side and desktop applications on Linux, macOS, and Windows. The API mirrors the Android SDK for code portability between mobile and server platforms.

  • Overview — JNI API overview and setup
  • Classes — PfC, PFCParam, PFCImageFile, and supporting classes

Data Structures

These core types are documented in the C API structs page.

  • StructsPFCIMAGE, PFCENGINE, PFCIMAGEPROFILE, geometry types, and correction parameter structs

Choosing an Interface

This table helps you select the appropriate interface based on your application requirements.

Use CaseRecommended Interface
Linux or macOS server-side processingC API or JNI API
Cross-platform desktop applicationsC API
Windows-only .NET applications.NET API
Unity or other C# game engines on Windows.NET API
Java server applicationsJNI API
Code sharing with Android mobile appsJNI API

All interfaces provide identical correction capabilities and wrap the same native library, so performance characteristics are equivalent.

PFC-SDK Version 11.0.0.1389 built from cc658dab3c675a529b3df2fa6421d4550810d77d on 06-29-2026.

Copyright © 2026 EyeQ Imaging Inc. All rights reserved.

On this page