arg.h

Go to the documentation of this file.

/*
 *  arg.h
 *  artoolkitX
 *
 *  Graphics Subroutines for artoolkitX.
 *
 *  This file is part of artoolkitX.
 *
 *  artoolkitX is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  artoolkitX is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with artoolkitX.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  As a special exception, the copyright holders of this library give you
 *  permission to link this library with independent modules to produce an
 *  executable, regardless of the license terms of these independent modules, and to
 *  copy and distribute the resulting executable under terms of your choice,
 *  provided that you also meet, for each linked independent module, the terms and
 *  conditions of the license of that module. An independent module is a module
 *  which is neither derived from nor based on this library. If you modify this
 *  library, you may extend this exception to your version of the library, but you
 *  are not obligated to do so. If you do not wish to do so, delete this exception
 *  statement from your version.
 *
 *  Copyright 2018 Realmax, Inc.
 *  Copyright 2015 Daqri, LLC.
 *  Copyright 2011-2015 ARToolworks, Inc.
 *
 *  Author(s): Philip Lamb
 *
 */
 
#ifndef __arg_h__
#define __arg_h__
 
// ============================================================================
//  Public includes.
// ============================================================================
 
#include <ARX/AR/ar.h>      // ARUint8, AR_PIXEL_FORMAT, ARParam, arParamObserv2Ideal()
 
#ifdef __cplusplus
extern "C" {
#endif
    
// ============================================================================
//  Public types and definitions.
// ============================================================================
 
#ifdef _WIN32
#  ifdef ARG_STATIC
#    define ARG_EXTERN
#  else
#    ifdef ARX_EXPORTS
#      define ARG_EXTERN __declspec(dllexport)
#    else
#      define ARG_EXTERN __declspec(dllimport)
#    endif
#  endif
#else
#  define ARG_EXTERN
#endif
 
typedef struct _ARGL_CONTEXT_SETTINGS *ARGL_CONTEXT_SETTINGS_REF;
 
typedef enum {
    ARG_API_None,       
    ARG_API_GL,         
    ARG_API_GL3,        
    ARG_API_GLES2       
} ARG_API;
 
// ============================================================================
//  Public functions.
// ============================================================================
 
ARG_EXTERN ARGL_CONTEXT_SETTINGS_REF arglSetupForCurrentContext(const ARParam *cparam, AR_PIXEL_FORMAT pixelFormat);
 
ARG_EXTERN int arglSetupDebugMode(ARGL_CONTEXT_SETTINGS_REF contextSettings, ARHandle *arHandle);
 
 
ARG_EXTERN void arglCleanup(ARGL_CONTEXT_SETTINGS_REF contextSettings);
 
ARG_EXTERN void arglDispImage(ARGL_CONTEXT_SETTINGS_REF contextSettings, int32_t viewport[4]);
 
ARG_EXTERN int arglDistortionCompensationSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int enable);
 
ARG_EXTERN int arglDistortionCompensationGet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int *enable);
 
ARG_EXTERN int arglSetPixelZoom(ARGL_CONTEXT_SETTINGS_REF contextSettings, float zoom);
 
ARG_EXTERN int arglGetPixelZoom(ARGL_CONTEXT_SETTINGS_REF contextSettings, float *zoom);
    
ARG_EXTERN int arglPixelFormatSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, AR_PIXEL_FORMAT format);
 
ARG_EXTERN int arglPixelFormatGet(ARGL_CONTEXT_SETTINGS_REF contextSettings, AR_PIXEL_FORMAT *format, int *size);
 
ARG_EXTERN int arglGetRotate90(ARGL_CONTEXT_SETTINGS_REF contextSettings);
 
ARG_EXTERN void arglSetRotate90(ARGL_CONTEXT_SETTINGS_REF contextSettings, int rotate90);
 
ARG_EXTERN int arglGetFlipH(ARGL_CONTEXT_SETTINGS_REF contextSettings);
ARG_EXTERN void arglSetFlipH(ARGL_CONTEXT_SETTINGS_REF contextSettings, int flipH);
ARG_EXTERN int arglGetFlipV(ARGL_CONTEXT_SETTINGS_REF contextSettings);
ARG_EXTERN void arglSetFlipV(ARGL_CONTEXT_SETTINGS_REF contextSettings, int flipV);
 
ARG_EXTERN int arglPixelBufferSizeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int bufWidth, int bufHeight);
 
ARG_EXTERN int arglPixelBufferSizeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int *bufWidth, int *bufHeight);
 
ARG_EXTERN int arglPixelBufferDataUploadBiPlanar(ARGL_CONTEXT_SETTINGS_REF contextSettings, ARUint8 *bufDataPtr0, ARUint8 *bufDataPtr1);
#define arglPixelBufferDataUpload(contextSettings,bufDataPtr) arglPixelBufferDataUploadBiPlanar(contextSettings,bufDataPtr,NULL)
    
ARG_EXTERN int arglGLCapabilityCheck(ARGL_CONTEXT_SETTINGS_REF contextSettings, const uint16_t minVersion, const unsigned char *extension);
 
#ifdef __cplusplus
}
#endif
 
#endif // !__arg_h__