src/glx/apple/apple_visual.h

/*
 Copyright (c) 2008 Apple Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation files
 (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge,
 publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT.  IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT
 HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
 Except as contained in this notice, the name(s) of the above
 copyright holders shall not be used in advertising or otherwise to
 promote the sale, use or other dealings in this Software without
 prior written authorization.
*/

#ifndef APPLE_VISUAL_H
#define APPLE_VISUAL_H

#include <stdbool.h>
#include <OpenGL/CGLTypes.h>
#include "glxconfig.h"

/*
 * Populate *pfobj with a CGLPixelFormatObj that matches the supplied glx_config,
 * requested OpenGL major/minor version, and profile_mask (a
 * GLX_CONTEXT_*_PROFILE_BIT_ARB value).  Returns kCGLNoError on success;
 * otherwise returns the CGLError from CGLChoosePixelFormat (or
 * kCGLBadPixelFormat if the platform returned no matching pixel formats).
 * *pfobj is left NULL on failure.
 */
CGLError apple_visual_create_pfobj(CGLPixelFormatObj * pfobj, const struct glx_config * mode,
                                   int major_version, int minor_version, int profile_mask,
                                   bool * double_buffered, bool * uses_stereo,
                                   bool offscreen);

#endif