1/*
2 Copyright (c) 2008, 2009 Apple Inc.
3
4 Permission is hereby granted, free of charge, to any person
5 obtaining a copy of this software and associated documentation files
6 (the "Software"), to deal in the Software without restriction,
7 including without limitation the rights to use, copy, modify, merge,
8 publish, distribute, sublicense, and/or sell copies of the Software,
9 and to permit persons to whom the Software is furnished to do so,
10 subject to the following conditions:
11
12 The above copyright notice and this permission notice shall be
13 included in all copies or substantial portions of the Software.
14
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 NONINFRINGEMENT.  IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT
19 HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23
24 Except as contained in this notice, the name(s) of the above
25 copyright holders shall not be used in advertising or otherwise to
26 promote the sale, use or other dealings in this Software without
27 prior written authorization.
28*/
29
30#include <stdbool.h>
31#include <stdio.h>
32#include <stdlib.h>
33#include <assert.h>
34#include <GL/gl.h>
35#include <util/debug.h>
36
37/* <rdar://problem/6953344> */
38#define glTexImage1D glTexImage1D_OSX
39#define glTexImage2D glTexImage2D_OSX
40#define glTexImage3D glTexImage3D_OSX
41#include <OpenGL/OpenGL.h>
42#include <OpenGL/CGLContext.h>
43#include <OpenGL/CGLRenderers.h>
44#include <OpenGL/CGLTypes.h>
45#undef glTexImage1D
46#undef glTexImage2D
47#undef glTexImage3D
48
49#ifndef kCGLPFAOpenGLProfile
50#define kCGLPFAOpenGLProfile 99
51#endif
52
53#ifndef kCGLOGLPVersion_3_2_Core
54#define kCGLOGLPVersion_3_2_Core 0x3200
55#endif
56
57#include "apple_cgl.h"
58#include "apple_visual.h"
59#include "apple_glx.h"
60#include "glxconfig.h"
61
62enum
63{
64   MAX_ATTR = 60
65};
66
67static char __crashreporter_info_buff__[4096] = { 0 };
68static const char *__crashreporter_info__ __attribute__((__used__)) =
69    &__crashreporter_info_buff__[0];
70#if MAC_OS_X_VERSION_MIN_REQUIRED >= 1050
71// This is actually a toolchain requirement, but I'm not sure the correct check,
72// but it should be fine to just only include it for Leopard and later.  This line
73// just tells the linker to never strip this symbol (such as for space optimization)
74__asm__ (".desc ___crashreporter_info__, 0x10");
75#endif
76
77void
78apple_visual_create_pfobj(CGLPixelFormatObj * pfobj, const struct glx_config * mode,
79                          bool * double_buffered, bool * uses_stereo,
80                          bool offscreen)
81{
82   CGLPixelFormatAttribute attr[MAX_ATTR];
83   int numattr = 0;
84   GLint vsref = 0;
85   CGLError error = 0;
86   bool use_core_profile = env_var_as_boolean("LIBGL_PROFILE_CORE", false);
87
88   if (offscreen) {
89      apple_glx_diagnostic
90         ("offscreen rendering enabled.  Using kCGLPFAOffScreen\n");
91
92      attr[numattr++] = kCGLPFAOffScreen;
93   }
94   else if (env_var_as_boolean("LIBGL_ALWAYS_SOFTWARE", false)) {
95      apple_glx_diagnostic
96         ("Software rendering requested.  Using kCGLRendererGenericFloatID.\n");
97      attr[numattr++] = kCGLPFARendererID;
98      attr[numattr++] = kCGLRendererGenericFloatID;
99   }
100   else if (env_var_as_boolean("LIBGL_ALLOW_SOFTWARE", false)) {
101      apple_glx_diagnostic
102         ("Software rendering is not being excluded.  Not using kCGLPFAAccelerated.\n");
103   }
104   else {
105      attr[numattr++] = kCGLPFAAccelerated;
106   }
107
108   /*
109    * The program chose a config based on the fbconfigs or visuals.
110    * Those are based on the attributes from CGL, so we probably
111    * do want the closest match for the color, depth, and accum.
112    */
113   attr[numattr++] = kCGLPFAClosestPolicy;
114
115   if (mode->stereoMode) {
116      attr[numattr++] = kCGLPFAStereo;
117      *uses_stereo = true;
118   }
119   else {
120      *uses_stereo = false;
121   }
122
123   if (!offscreen && mode->doubleBufferMode) {
124      attr[numattr++] = kCGLPFADoubleBuffer;
125      *double_buffered = true;
126   }
127   else {
128      *double_buffered = false;
129   }
130
131   attr[numattr++] = kCGLPFAColorSize;
132   attr[numattr++] = mode->redBits + mode->greenBits + mode->blueBits;
133   attr[numattr++] = kCGLPFAAlphaSize;
134   attr[numattr++] = mode->alphaBits;
135
136   if ((mode->accumRedBits + mode->accumGreenBits + mode->accumBlueBits) > 0) {
137      attr[numattr++] = kCGLPFAAccumSize;
138      attr[numattr++] = mode->accumRedBits + mode->accumGreenBits +
139         mode->accumBlueBits + mode->accumAlphaBits;
140   }
141
142   if (mode->depthBits > 0) {
143      attr[numattr++] = kCGLPFADepthSize;
144      attr[numattr++] = mode->depthBits;
145   }
146
147   if (mode->stencilBits > 0) {
148      attr[numattr++] = kCGLPFAStencilSize;
149      attr[numattr++] = mode->stencilBits;
150   }
151
152   if (mode->sampleBuffers > 0) {
153      attr[numattr++] = kCGLPFAMultisample;
154      attr[numattr++] = kCGLPFASampleBuffers;
155      attr[numattr++] = mode->sampleBuffers;
156      attr[numattr++] = kCGLPFASamples;
157      attr[numattr++] = mode->samples;
158   }
159
160   /* Debugging support for Core profiles to support newer versions of OpenGL */
161   if (use_core_profile) {
162      attr[numattr++] = kCGLPFAOpenGLProfile;
163      attr[numattr++] = kCGLOGLPVersion_3_2_Core;
164   }
165
166   attr[numattr++] = 0;
167
168   assert(numattr < MAX_ATTR);
169
170   error = apple_cgl.choose_pixel_format(attr, pfobj, &vsref);
171
172   if ((error == kCGLBadAttribute || vsref == 0) && use_core_profile) {
173      apple_glx_diagnostic
174         ("Trying again without CoreProfile: error=%s, vsref=%d\n", apple_cgl.error_string(error), vsref);
175
176      if (!error)
177         apple_cgl.destroy_pixel_format(*pfobj);
178
179      numattr -= 3;
180      attr[numattr++] = 0;
181
182      error = apple_cgl.choose_pixel_format(attr, pfobj, &vsref);
183   }
184
185   if (error) {
186      snprintf(__crashreporter_info_buff__, sizeof(__crashreporter_info_buff__),
187               "CGLChoosePixelFormat error: %s\n", apple_cgl.error_string(error));
188      fprintf(stderr, "%s", __crashreporter_info_buff__);
189      abort();
190   }
191
192   if (!*pfobj) {
193      snprintf(__crashreporter_info_buff__, sizeof(__crashreporter_info_buff__),
194               "No matching pixelformats found, perhaps try setting LIBGL_ALLOW_SOFTWARE=true\n");
195      fprintf(stderr, "%s", __crashreporter_info_buff__);
196      abort();
197   }
198}
199