//---------------------------------------------------------------------------

//

//  File: Buffer.h

//

//  Abstract: A utility class to create an OpenCL memory buffer

//           

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

//  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) 2009 Apple Inc., All rights reserved.

//

//---------------------------------------------------------------------------

#ifndef _OPENCL_BUFFER_H_

#define _OPENCL_BUFFER_H_

#ifdef __cplusplus

//---------------------------------------------------------------------------

//---------------------------------------------------------------------------

#include "OpenCLProgram.h"

//---------------------------------------------------------------------------

//---------------------------------------------------------------------------

namespace OpenCL

{

    class BufferStruct;

    class Buffer

    {

        public:

            Buffer(const Program &rProgram);

            Buffer(const Program *pProgram);

            Buffer(const Buffer &rBuffer);

            Buffer &operator=(const Buffer &rBuffer);

            ~Buffer();

            void SetDefaults();

            void SetReadOnly();

            void SetWriteOnly();

            void SetReadWrite();

            void SetIsBlocking();

            void SetIsNonBlocking();

            const cl_mem  GetBuffer()      const;

            const size_t  GetBufferSize()  const;

            const cl_uint GetBufferIndex() const;

            bool Acquire(const cl_uint nBufferIndex, const size_t nBufferSize);

            bool Acquire(const cl_uint nBufferIndex, const size_t nBufferSize, void *pHost);

            bool Read(const size_t nBufferSize, void *pHost);

            bool Write(const size_t nBufferSize, const void * const pHost);

            bool Copy(Buffer &rSrcBuffer);

            bool Copy(const size_t nBufferSize, Buffer &rSrcBuffer);

        private:

            BufferStruct  *mpBuffer;

    }; // Buffer

} // OpenCL

//---------------------------------------------------------------------------

//---------------------------------------------------------------------------

#endif

#endif