/*

     File: GLUArray.h

 Abstract: 

 Utility toolkit for interleaved array management.

  Version: 1.2

 Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

 Inc. ("Apple") in consideration of your agreement to the following

 terms, and your use, installation, modification or redistribution of

 this Apple software constitutes acceptance of these terms.  If you do

 not agree with these terms, please do not use, install, modify or

 redistribute this Apple software.

 In consideration of your agreement to abide by the following terms, and

 subject to these terms, Apple grants you a personal, non-exclusive

 license, under Apple's copyrights in this original Apple software (the

 "Apple Software"), to use, reproduce, modify and redistribute the Apple

 Software, with or without modifications, in source and/or binary forms;

 provided that if you redistribute the Apple Software in its entirety and

 without modifications, you must retain this notice and the following

 text and disclaimers in all such redistributions of the Apple Software.

 Neither the name, trademarks, service marks or logos of Apple Inc. may

 be used to endorse or promote products derived from the Apple Software

 without specific prior written permission from Apple.  Except as

 expressly stated in this notice, no other rights or licenses, express or

 implied, are granted by Apple herein, including but not limited to any

 patent rights that may be infringed by your derivative works or by other

 works in which the Apple Software may be incorporated.

 The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

 MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

 THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

 FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

 OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

 MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

 AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

 STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

 POSSIBILITY OF SUCH DAMAGE.

 Copyright (C) 2014 Apple Inc. All Rights Reserved.

 */

// MacOS X

#ifndef _GL_UTILITIES_ARRAY_H_

#define _GL_UTILITIES_ARRAY_H_

// Mac OS X frameworks

#import <Cocoa/Cocoa.h>

#import <OpenGL/OpenGL.h>

#import <simd/simd.h>

#ifdef __cplusplus

namespace GLU

{

    // In a large scale system architecture, instead of exposing the data

    // structure, one would hide all the instance variables and instead

    // expose a single opaque data reference.  In this case our opaque data

    // reference is represented by a pointer to Array structure.  The

    // details of this data structure are hidden and only exposed in the

    // implementation file.  All subsequent methods then work with this

    // opaque data reference.

    typedef struct Array *ArrayRef;

    // Create an interleaved array for 2D objects

    ArrayRef ArrayCreate(const GLuint& rCount,

                         const GLfloat * const pPositions,

                         const GLfloat * const pTexCoords,

                         const GLfloat * const pColors);

    // Create an interleaved array for 3D objects

    ArrayRef ArrayCreate(const GLuint& rCount,

                         const GLfloat * const pPositions,

                         const GLfloat * const pNormals,

                         const GLfloat * const pTexCoords,

                         const GLfloat * const pColors);

    // Create an interleaved array for a quad 2D object

    ArrayRef ArrayCreateQuad(const GLfloat * const pPositions,

                             const GLfloat * const pTexCoords,

                             const GLfloat * const pColors);

    // Delete 2D/3D interleaved array

    void ArrayDelete(ArrayRef pArray);

    // The vertex count

    const GLuint ArrayGetCount(const ArrayRef pArray);

    // Accessors for 2D positions in an interleaved array

    const vector_float2 ArrayGetPosition2D(const GLuint& rIndex, const ArrayRef pArray);

    // Accessors for 2D texture coordinates in an interleaved array

    const vector_float2 ArrayGetTexCoords2D(const GLuint& rIndex, const ArrayRef pArray);

    // Accessors for 3D position in an interleaved array

    const vector_float3 ArrayGetPosition3D(const GLuint& rIndex, const ArrayRef pArray);

    // Accessors for 3D normals in an interleaved array

    const vector_float3 ArrayGetNormals3D(const GLuint& rIndex, const ArrayRef pArray);

    // Accessors for 3D texture coordinates in an interleaved array

    const vector_float3 ArrayGetTexCoords3D(const GLuint& rIndex, const ArrayRef pArray);

    // Accessors for vertex color in an interleaved array

    const vector_float4 ArrayGetColors(const GLuint& rIndex, const ArrayRef pArray);

} // GLU

#endif

#endif