Skip to content

Latest commit

 

History

History
783 lines (715 loc) · 29.6 KB

mojoshader.h

File metadata and controls

783 lines (715 loc) · 29.6 KB
 
Feb 10, 2008
Feb 10, 2008
1
/**
Mar 22, 2008
Mar 22, 2008
2
3
* MojoShader; generate shader programs from bytecode of compiled
* Direct3D shaders.
Feb 10, 2008
Feb 10, 2008
4
5
6
7
8
9
*
* Please see the file LICENSE.txt in the source's root directory.
*
* This file written by Ryan C. Gordon.
*/
Mar 22, 2008
Mar 22, 2008
10
11
#ifndef __INCL_MOJOSHADER_H_
#define __INCL_MOJOSHADER_H_
Feb 10, 2008
Feb 10, 2008
12
13
14
15
16
#ifdef __cplusplus
extern "C" {
#endif
Mar 16, 2008
Mar 16, 2008
17
/*
Mar 28, 2008
Mar 28, 2008
18
19
20
21
22
* For determining the version of MojoShader you are using:
* const int compiled_against = MOJOSHADER_VERSION;
* const int linked_against = MOJOSHADER_version();
*
* The version is a single integer that increments, not a major/minor value.
Mar 16, 2008
Mar 16, 2008
23
*/
Mar 22, 2008
Mar 22, 2008
24
25
#define MOJOSHADER_VERSION 1
int MOJOSHADER_version(void);
Mar 16, 2008
Mar 16, 2008
26
27
28
/*
* These allocators work just like the C runtime's malloc() and free()
Mar 28, 2008
Mar 28, 2008
29
30
* (in fact, they probably use malloc() and free() internally if you don't
* specify your own allocator, but don't rely on that behaviour).
Apr 4, 2008
Apr 4, 2008
31
32
33
* (data) is the pointer you supplied when specifying these allocator
* callbacks, in case you need instance-specific data...it is passed through
* to your allocator unmolested, and can be NULL if you like.
Mar 16, 2008
Mar 16, 2008
34
*/
Apr 4, 2008
Apr 4, 2008
35
36
typedef void *(*MOJOSHADER_malloc)(int bytes, void *data);
typedef void (*MOJOSHADER_free)(void *ptr, void *data);
Mar 14, 2008
Mar 14, 2008
37
Mar 28, 2008
Mar 28, 2008
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
* These are enum values, but they also can be used in bitmasks, so we can
* test if an opcode is acceptable: if (op->shader_types & ourtype) {} ...
*/
typedef enum
{
MOJOSHADER_TYPE_UNKNOWN = 0,
MOJOSHADER_TYPE_PIXEL = (1 << 0),
MOJOSHADER_TYPE_VERTEX = (1 << 1),
MOJOSHADER_TYPE_GEOMETRY = (1 << 2), /* (not supported yet.) */
MOJOSHADER_TYPE_ANY = 0xFFFFFFFF /* used for bitmasks */
} MOJOSHADER_shaderType;
Apr 26, 2008
Apr 26, 2008
52
53
54
55
56
/*
* Data types for vertex attribute streams.
*/
typedef enum
{
Apr 28, 2008
Apr 28, 2008
57
MOJOSHADER_ATTRIBUTE_UNKNOWN = -1, /* housekeeping; not returned. */
Apr 26, 2008
Apr 26, 2008
58
59
60
61
62
63
64
MOJOSHADER_ATTRIBUTE_BYTE,
MOJOSHADER_ATTRIBUTE_UBYTE,
MOJOSHADER_ATTRIBUTE_SHORT,
MOJOSHADER_ATTRIBUTE_USHORT,
MOJOSHADER_ATTRIBUTE_INT,
MOJOSHADER_ATTRIBUTE_UINT,
MOJOSHADER_ATTRIBUTE_FLOAT,
Apr 28, 2008
Apr 28, 2008
65
66
MOJOSHADER_ATTRIBUTE_DOUBLE,
MOJOSHADER_ATTRIBUTE_HALF_FLOAT, /* MAYBE available in your OpenGL! */
Apr 26, 2008
Apr 26, 2008
67
68
} MOJOSHADER_attributeType;
Apr 4, 2008
Apr 4, 2008
69
70
71
/*
* Data types for uniforms. See MOJOSHADER_uniform for more information.
*/
Apr 4, 2008
Apr 4, 2008
72
73
typedef enum
{
Apr 28, 2008
Apr 28, 2008
74
MOJOSHADER_UNIFORM_UNKNOWN = -1, /* housekeeping value; never returned. */
Apr 19, 2008
Apr 19, 2008
75
76
77
MOJOSHADER_UNIFORM_FLOAT,
MOJOSHADER_UNIFORM_INT,
MOJOSHADER_UNIFORM_BOOL,
Apr 4, 2008
Apr 4, 2008
78
} MOJOSHADER_uniformType;
Apr 4, 2008
Apr 4, 2008
79
Apr 4, 2008
Apr 4, 2008
80
81
82
83
84
85
86
/*
* These are the uniforms to be set for a shader. "Uniforms" are what Direct3D
* calls "Constants" ... IDirect3DDevice::SetVertexShaderConstantF() would
* need this data, for example. These integers are register indexes. So if
* index==6 and type==MOJOSHADER_UNIFORM_FLOAT, that means we'd expect a
* 4-float vector to be specified for what would be register "c6" in D3D
* assembly language, before drawing with the shader.
Apr 25, 2008
Apr 25, 2008
87
88
* (name) is a profile-specific variable name; it may be NULL if it isn't
* applicable to the requested profile.
Apr 4, 2008
Apr 4, 2008
89
*/
Apr 4, 2008
Apr 4, 2008
90
91
typedef struct
{
Apr 4, 2008
Apr 4, 2008
92
MOJOSHADER_uniformType type;
Apr 5, 2008
Apr 5, 2008
93
int index;
Apr 25, 2008
Apr 25, 2008
94
const char *name;
Apr 4, 2008
Apr 4, 2008
95
96
} MOJOSHADER_uniform;
Apr 19, 2008
Apr 19, 2008
97
98
99
100
101
/*
* Data types for samplers. See MOJOSHADER_sampler for more information.
*/
typedef enum
{
Apr 28, 2008
Apr 28, 2008
102
MOJOSHADER_SAMPLER_UNKNOWN = -1, /* housekeeping value; never returned. */
Apr 19, 2008
Apr 19, 2008
103
104
105
106
107
108
109
110
111
112
113
114
MOJOSHADER_SAMPLER_2D,
MOJOSHADER_SAMPLER_CUBE,
MOJOSHADER_SAMPLER_VOLUME,
} MOJOSHADER_samplerType;
/*
* These are the samplers to be set for a shader. ...
* IDirect3DDevice::SetTexture() would need this data, for example.
* These integers are the sampler "stage". So if index==6 and
* type==MOJOSHADER_SAMPLER_2D, that means we'd expect a regular 2D texture
* to be specified for what would be register "s6" in D3D assembly language,
* before drawing with the shader.
Apr 25, 2008
Apr 25, 2008
115
116
* (name) is a profile-specific variable name; it may be NULL if it isn't
* applicable to the requested profile.
Apr 19, 2008
Apr 19, 2008
117
118
119
120
121
*/
typedef struct
{
MOJOSHADER_samplerType type;
int index;
Apr 25, 2008
Apr 25, 2008
122
const char *name;
Apr 19, 2008
Apr 19, 2008
123
124
} MOJOSHADER_sampler;
Apr 5, 2008
Apr 5, 2008
125
126
127
128
129
/*
* Data types for attributes. See MOJOSHADER_attribute for more information.
*/
typedef enum
{
Apr 28, 2008
Apr 28, 2008
130
MOJOSHADER_USAGE_UNKNOWN = -1, /* housekeeping value; never returned. */
Apr 19, 2008
Apr 19, 2008
131
132
133
134
135
136
137
138
139
140
141
142
143
144
MOJOSHADER_USAGE_POSITION,
MOJOSHADER_USAGE_BLENDWEIGHT,
MOJOSHADER_USAGE_BLENDINDICES,
MOJOSHADER_USAGE_NORMAL,
MOJOSHADER_USAGE_POINTSIZE,
MOJOSHADER_USAGE_TEXCOORD,
MOJOSHADER_USAGE_TANGENT,
MOJOSHADER_USAGE_BINORMAL,
MOJOSHADER_USAGE_TESSFACTOR,
MOJOSHADER_USAGE_POSITIONT,
MOJOSHADER_USAGE_COLOR,
MOJOSHADER_USAGE_FOG,
MOJOSHADER_USAGE_DEPTH,
MOJOSHADER_USAGE_SAMPLE,
Apr 28, 2008
Apr 28, 2008
145
MOJOSHADER_USAGE_TOTAL, /* housekeeping value; never returned. */
Apr 5, 2008
Apr 5, 2008
146
147
148
149
150
151
152
153
154
155
} MOJOSHADER_usage;
/*
* These are the attributes to be set for a shader. "Attributes" are what
* Direct3D calls "Vertex Declarations Usages" ...
* IDirect3DDevice::CreateVertexDeclaration() would need this data, for
* example. Each attribute is associated with an array of data that uses one
* element per-vertex. So if usage==MOJOSHADER_USAGE_COLOR and index==1, that
* means we'd expect a secondary color array to be bound to this shader
* before drawing.
Apr 25, 2008
Apr 25, 2008
156
157
* (name) is a profile-specific variable name; it may be NULL if it isn't
* applicable to the requested profile.
Apr 5, 2008
Apr 5, 2008
158
159
160
161
162
*/
typedef struct
{
MOJOSHADER_usage usage;
int index;
Apr 25, 2008
Apr 25, 2008
163
const char *name;
Apr 5, 2008
Apr 5, 2008
164
} MOJOSHADER_attribute;
Mar 28, 2008
Mar 28, 2008
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
* Structure used to return data from parsing of a shader...
*/
typedef struct
{
/*
* Human-readable error, if there is one. Will be NULL if there was no
* error. The string will be UTF-8 encoded, and English only. Most of
* these shouldn't be shown to the end-user anyhow.
*/
const char *error;
Apr 23, 2008
Apr 23, 2008
178
179
180
181
182
/*
* The name of the profile used to parse the shader. Will be NULL on error.
*/
const char *profile;
Mar 28, 2008
Mar 28, 2008
183
184
185
186
187
188
189
190
191
/*
* Bytes of output from parsing. Most profiles produce a string of source
* code, but profiles that do binary output may not be text at all.
* Will be NULL on error.
*/
const char *output;
/*
* Byte count for output, not counting any null terminator. Most profiles
Apr 6, 2008
Apr 6, 2008
192
193
194
* produce an ASCII string of source code (which will be null-terminated
* even though that null char isn't included in output_len), but profiles
* that do binary output may not be text at all. Will be 0 on error.
Mar 28, 2008
Mar 28, 2008
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
*/
int output_len;
/*
* Count of Direct3D instructions we parsed. This is meaningless in terms
* of the actual output, as the profile will probably grow or reduce
* the count (or for high-level languages, not have that information at
* all), but it can give you a rough idea of the size of your shader.
* Will be zero on error.
*/
int instruction_count;
/*
* The type of shader we parsed. Will be MOJOSHADER_TYPE_UNKNOWN on error.
*/
MOJOSHADER_shaderType shader_type;
/*
* The shader's major version. If this was a "vs_3_0", this would be 3.
*/
int major_ver;
/*
* The shader's minor version. If this was a "ps_1_4", this would be 4.
* Two notes: for "vs_2_x", this is 1, and for "vs_3_sw", this is 255.
*/
int minor_ver;
Apr 4, 2008
Apr 4, 2008
223
224
225
226
227
228
/*
* The number of elements pointed to by (uniforms).
*/
int uniform_count;
/*
Apr 4, 2008
Apr 4, 2008
229
230
* (uniform_count) elements of data that specify Uniforms to be set for
* this shader. See discussion on MOJOSHADER_uniform for details.
Apr 19, 2008
Apr 19, 2008
231
* This can be NULL on error or if (uniform_count) is zero.
Apr 4, 2008
Apr 4, 2008
232
233
234
*/
MOJOSHADER_uniform *uniforms;
Apr 19, 2008
Apr 19, 2008
235
236
237
238
239
240
241
242
243
244
245
246
/*
* The number of elements pointed to by (samplers).
*/
int sampler_count;
/*
* (sampler_count) elements of data that specify Samplers to be set for
* this shader. See discussion on MOJOSHADER_sampler for details.
* This can be NULL on error or if (sampler_count) is zero.
*/
MOJOSHADER_sampler *samplers;
Apr 5, 2008
Apr 5, 2008
247
248
249
250
251
252
253
254
/*
* The number of elements pointed to by (attributes).
*/
int attribute_count;
/*
* (attribute_count) elements of data that specify Attributes to be set
* for this shader. See discussion on MOJOSHADER_attribute for details.
Apr 19, 2008
Apr 19, 2008
255
* This can be NULL on error or if (attribute_count) is zero.
Apr 5, 2008
Apr 5, 2008
256
257
258
*/
MOJOSHADER_attribute *attributes;
Mar 28, 2008
Mar 28, 2008
259
260
261
262
263
264
265
266
267
/*
* This is the malloc implementation you passed to MOJOSHADER_parse().
*/
MOJOSHADER_malloc malloc;
/*
* This is the free implementation you passed to MOJOSHADER_parse().
*/
MOJOSHADER_free free;
Apr 4, 2008
Apr 4, 2008
268
269
270
271
272
/*
* This is the pointer you passed as opaque data for your allocator.
*/
void *malloc_data;
Mar 28, 2008
Mar 28, 2008
273
274
275
276
277
278
279
280
} MOJOSHADER_parseData;
/*
* Profile string for Direct3D assembly language output.
*/
#define MOJOSHADER_PROFILE_D3D "d3d"
Apr 6, 2008
Apr 6, 2008
281
282
283
284
285
/*
* Profile string for passthrough of the original bytecode, unchanged.
*/
#define MOJOSHADER_PROFILE_PASSTHROUGH "passthrough"
Mar 28, 2008
Mar 28, 2008
286
287
288
289
290
/*
* Profile string for GLSL: OpenGL high-level shader language output.
*/
#define MOJOSHADER_PROFILE_GLSL "glsl"
Apr 4, 2008
Apr 4, 2008
291
Mar 28, 2008
Mar 28, 2008
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/*
* Parse a compiled Direct3D shader's bytecode.
*
* This is your primary entry point into MojoShader. You need to pass it
* a compiled D3D shader and tell it which "profile" you want to use to
* convert it into useful data.
*
* The available profiles are the set of MOJOSHADER_PROFILE_* defines.
* Note that MojoShader may be built without support for all listed
* profiles (in which case using one here will return with an error).
*
* As parsing requires some memory to be allocated, you may provide a custom
* allocator to this function, which will be used to allocate/free memory.
* They function just like malloc() and free(). We do not use realloc().
Apr 4, 2008
Apr 4, 2008
306
307
308
* If you don't care, pass NULL in for the allocator functions. If your
* allocator needs instance-specific data, you may supply it with the
* (d) parameter. This pointer is passed as-is to your (m) and (f) functions.
Mar 28, 2008
Mar 28, 2008
309
*
Apr 4, 2008
Apr 4, 2008
310
* This function returns a MOJOSHADER_parseData.
Mar 28, 2008
Mar 28, 2008
311
312
313
314
315
316
*
* This function will never return NULL, even if the system is completely
* out of memory upon entry (in which case, this function returns a static
* MOJOSHADER_parseData object, which is still safe to pass to
* MOJOSHADER_freeParseData()).
*
Apr 23, 2008
Apr 23, 2008
317
* This function is thread safe, so long as (m) and (f) are too, and that
Mar 28, 2008
Mar 28, 2008
318
319
320
321
322
323
324
* (tokenbuf) remains intact for the duration of the call. This allows you
* to parse several shaders on separate CPU cores at the same time.
*/
const MOJOSHADER_parseData *MOJOSHADER_parse(const char *profile,
const unsigned char *tokenbuf,
const unsigned int bufsize,
MOJOSHADER_malloc m,
Apr 4, 2008
Apr 4, 2008
325
326
MOJOSHADER_free f,
void *d);
Mar 28, 2008
Mar 28, 2008
327
328
329
330
331
332
333
334
335
336
337
/*
* Call this to dispose of parsing results when you are done with them.
* This will call the MOJOSHADER_free function you provided to
* MOJOSHADER_parse multiple times, if you provided one.
* Passing a NULL here is a safe no-op.
*
* This function is thread safe, so long as any allocator you passed into
* MOJOSHADER_parse() is, too.
*/
void MOJOSHADER_freeParseData(const MOJOSHADER_parseData *data);
Feb 10, 2008
Feb 10, 2008
338
Apr 26, 2008
Apr 26, 2008
339
Apr 27, 2008
Apr 27, 2008
340
341
342
343
/* OpenGL interface... */
Apr 28, 2008
Apr 28, 2008
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/*
* "Contexts" map to OpenGL contexts...you need one per window, or whatever,
* and need to inform MojoShader when you make a new one current.
*
* "Shaders" refer to individual vertex or pixel programs, and are created
* by "compiling" Direct3D shader bytecode. A vertex and pixel shader are
* "linked" into a "Program" before you can use them to render.
*
* To the calling application, these are all opaque handles.
*/
typedef struct MOJOSHADER_glContext MOJOSHADER_glContext;
typedef struct MOJOSHADER_glShader MOJOSHADER_glShader;
typedef struct MOJOSHADER_glProgram MOJOSHADER_glProgram;
Apr 30, 2008
Apr 30, 2008
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
/*
* Determine the best profile to use for the current system.
*
* You do not need to call this if all you want is MOJOSHADER_parse().
*
* You can only call this AFTER you have successfully built your GL context
* and made it current. This function will lookup the GL functions it needs
* through the callback you supply. The lookup function is neither stored nor
* used by MojoShader after this function returns, nor are the functions it
* might look up.
*
* Returns the name of the "best" profile on success, NULL if none of the
* available profiles will work on this system. "Best" is a relative term,
* but it generally means the best trade off between feature set and
* performance. The selection algorithm may be arbitrary and complex.
*
* The returned value is an internal static string, and should not be free()'d
* by the caller. If you get a NULL, calling MOJOSHADER_glGetError() might
* shed some light on why.
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
*/
const char *MOJOSHADER_glBestProfile(void *(*lookup)(const char *fnname));
Apr 26, 2008
Apr 26, 2008
386
387
388
389
390
391
392
393
/*
* Prepare MojoShader to manage OpenGL shaders.
*
* You do not need to call this if all you want is MOJOSHADER_parse().
*
* You must call this once AFTER you have successfully built your GL context
* and made it current. This function will lookup the GL functions it needs
* through the callback you supply, after which it may call them at any time
Apr 28, 2008
Apr 28, 2008
394
395
* up until you call MOJOSHADER_glDestroyContext(). The lookup function is
* neither stored nor used by MojoShader after this function returns.
Apr 26, 2008
Apr 26, 2008
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
*
* (profile) is an OpenGL-specific MojoShader profile, which decides how
* Direct3D bytecode shaders get turned into OpenGL programs, and how they
* are fed to the GL.
*
* (lookup) is a callback that is used to load GL entry points. This callback
* has to look up base GL functions and extension entry points.
*
* As MojoShader requires some memory to be allocated, you may provide a
* custom allocator to this function, which will be used to allocate/free
* memory. They function just like malloc() and free(). We do not use
* realloc(). If you don't care, pass NULL in for the allocator functions.
* If your allocator needs instance-specific data, you may supply it with the
* (d) parameter. This pointer is passed as-is to your (m) and (f) functions.
*
Apr 28, 2008
Apr 28, 2008
411
412
413
* Returns a new context on success, NULL on error. If you get a new context,
* you need to make it current before using it with
* MOJOSHADER_glMakeContextCurrent().
Apr 26, 2008
Apr 26, 2008
414
415
416
417
418
419
*
* This call is NOT thread safe! It must return success before you may call
* any other MOJOSHADER_gl* function. Also, as most OpenGL implementations
* are not thread safe, you should probably only call this from the same
* thread that created the GL context.
*/
Apr 28, 2008
Apr 28, 2008
420
MOJOSHADER_glContext *MOJOSHADER_glCreateContext(const char *profile,
Apr 28, 2008
Apr 28, 2008
421
422
423
424
425
426
void *(*lookup)(const char *fnname),
MOJOSHADER_malloc m, MOJOSHADER_free f,
void *d);
/*
* You must call this before using the context that you got from
Apr 28, 2008
Apr 28, 2008
427
428
* MOJOSHADER_glCreateContext(), and must use it when you switch to a new GL
* context.
Apr 28, 2008
Apr 28, 2008
429
430
431
432
433
434
435
436
*
* You can only have one MOJOSHADER_glContext per actual GL context, or
* undefined behaviour will result.
*
* It is legal to call this with a NULL pointer to make no context current,
* but you need a valid context to be current to use most of MojoShader.
*/
void MOJOSHADER_glMakeContextCurrent(MOJOSHADER_glContext *ctx);
Apr 26, 2008
Apr 26, 2008
437
Apr 27, 2008
Apr 27, 2008
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
/*
* Get any error state we might have picked up. MojoShader will NOT call
* glGetError() internally, but there are other errors we can pick up,
* such as failed shader compilation, etc.
*
* Returns a human-readable string. This string is for debugging purposes, and
* not guaranteed to be localized, coherent, or user-friendly in any way.
* It's for programmers!
*
* The latest error may remain between calls. New errors replace any existing
* error. Don't check this string for a sign that an error happened, check
* return codes instead and use this for explanation when debugging.
*
* Do not free the returned string: it's a pointer to a static internal
* buffer. Do not keep the pointer around, either, as it's likely to become
* invalid as soon as you call into MojoShader again.
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 26, 2008
Apr 26, 2008
458
*
Apr 28, 2008
Apr 28, 2008
459
460
* This call does NOT require a valid MOJOSHADER_glContext to have been made
* current. The error buffer is shared between contexts, so you can get
Apr 28, 2008
Apr 28, 2008
461
* error results from a failed MOJOSHADER_glCreateContext().
Apr 26, 2008
Apr 26, 2008
462
*/
Apr 28, 2008
Apr 28, 2008
463
const char *MOJOSHADER_glGetError(void);
Apr 26, 2008
Apr 26, 2008
464
465
466
467
468
469
470
471
472
/*
* Compile a buffer of Direct3D shader bytecode into an OpenGL shader.
* You still need to link the shader before you may render with it.
*
* (tokenbuf) is a buffer of Direct3D shader bytecode.
* (bufsize) is the size, in bytes, of the bytecode buffer.
*
* Returns NULL on error, or a shader handle on success.
Apr 27, 2008
Apr 27, 2008
473
474
475
476
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
477
478
479
480
481
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
*
* Compiled shaders from this function may not be shared between contexts.
Apr 26, 2008
Apr 26, 2008
482
*/
Apr 26, 2008
Apr 26, 2008
483
484
MOJOSHADER_glShader *MOJOSHADER_glCompileShader(const unsigned char *tokenbuf,
const unsigned int bufsize);
Apr 26, 2008
Apr 26, 2008
485
Apr 29, 2008
Apr 29, 2008
486
487
488
489
490
491
492
493
494
495
/*
* Get the MOJOSHADER_parseData structure that was produced from the
* call to MOJOSHADER_glCompileShader().
*
* This data is read-only, and you should NOT attempt to free it. This
* pointer remains valid until the shader is deleted.
*/
const MOJOSHADER_parseData *MOJOSHADER_glGetShaderParseData(
MOJOSHADER_glShader *shader);
Apr 26, 2008
Apr 26, 2008
496
/*
Apr 26, 2008
Apr 26, 2008
497
498
499
500
501
* Link a vertex and pixel shader into an OpenGL program.
* (vshader) or (pshader) can be NULL, to specify that the GL should use the
* fixed-function pipeline instead of the programmable pipeline for that
* portion of the work. You can reuse shaders in various combinations across
* multiple programs, by relinking different pairs.
Apr 26, 2008
Apr 26, 2008
502
*
Apr 26, 2008
Apr 26, 2008
503
504
* It is illegal to give a vertex shader for (pshader) or a pixel shader
* for (vshader).
Apr 26, 2008
Apr 26, 2008
505
506
507
508
*
* Once you have successfully linked a program, you may render with it.
*
* Returns NULL on error, or a program handle on success.
Apr 27, 2008
Apr 27, 2008
509
510
511
512
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
513
514
515
516
517
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
*
* Linked programs from this function may not be shared between contexts.
Apr 26, 2008
Apr 26, 2008
518
*/
Apr 26, 2008
Apr 26, 2008
519
520
MOJOSHADER_glProgram *MOJOSHADER_glLinkProgram(MOJOSHADER_glShader *vshader,
MOJOSHADER_glShader *pshader);
Apr 26, 2008
Apr 26, 2008
521
522
523
524
525
526
527
528
529
530
531
532
533
534
/*
* This binds the program (using, for example, glUseProgramObjectARB()), and
* disables all the client-side arrays so we can reset them with new values
* if appropriate.
*
* Call with NULL to disable the programmable pipeline and all enabled
* client-side arrays.
*
* After binding a program, you should update any uniforms you care about
* with MOJOSHADER_glSetVertexShaderUniformF() (etc), set any vertex arrays
* you want to use with MOJOSHADER_glSetVertexAttribute(), and finally call
* MOJOSHADER_glProgramReady() to commit everything to the GL. Then you may
* begin drawing through standard GL entry points.
Apr 27, 2008
Apr 27, 2008
535
536
537
538
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
539
540
541
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 26, 2008
Apr 26, 2008
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
*/
void MOJOSHADER_glBindProgram(MOJOSHADER_glProgram *program);
/*
* Set a floating-point uniform value (what Direct3D calls a "constant").
*
* There is a single array of 4-float "registers" shared by all vertex shaders.
* This is the "c" register file in Direct3D (c0, c1, c2, etc...)
* MojoShader will take care of synchronizing this internal array with the
* appropriate variables in the GL shaders.
*
* (idx) is the index into the internal array: 0 is the first four floats,
* 1 is the next four, etc.
* (data) is a pointer to (vec4count*4) floats.
Apr 27, 2008
Apr 27, 2008
557
558
559
560
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
561
562
563
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
564
565
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
*/
void MOJOSHADER_glSetVertexShaderUniformF(unsigned int idx, const float *data,
unsigned int vec4count);
/*
* Set an integer uniform value (what Direct3D calls a "constant").
*
* There is a single array of 4-int "registers" shared by all vertex shaders.
* This is the "i" register file in Direct3D (i0, i1, i2, etc...)
* MojoShader will take care of synchronizing this internal array with the
* appropriate variables in the GL shaders.
*
* (idx) is the index into the internal array: 0 is the first four ints,
* 1 is the next four, etc.
* (data) is a pointer to (ivec4count*4) ints.
Apr 27, 2008
Apr 27, 2008
581
582
583
584
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
585
586
587
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
588
589
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
*/
void MOJOSHADER_glSetVertexShaderUniformI(unsigned int idx, const int *data,
unsigned int ivec4count);
/*
* Set a boolean uniform value (what Direct3D calls a "constant").
*
* There is a single array of "registers" shared by all vertex shaders.
* This is the "b" register file in Direct3D (b0, b1, b2, etc...)
* MojoShader will take care of synchronizing this internal array with the
* appropriate variables in the GL shaders.
*
* Unlike the float and int counterparts, booleans are single values, not
* four-element vectors...so idx==1 is the second boolean in the internal
* array, not the fifth.
*
* Non-zero values are considered "true" and zero is considered "false".
*
* (idx) is the index into the internal array.
* (data) is a pointer to (bcount) ints.
Apr 27, 2008
Apr 27, 2008
610
611
612
613
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
614
615
616
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
617
618
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
619
620
621
622
*/
void MOJOSHADER_glSetVertexShaderUniformB(unsigned int idx, const int *data,
unsigned int bcount);
Apr 26, 2008
Apr 26, 2008
623
624
625
626
/*
* The equivalent of MOJOSHADER_glSetVertexShaderUniformF() for pixel
* shaders. Other than using a different internal array that is specific
* to pixel shaders, this functions just like its vertex array equivalent.
Apr 27, 2008
Apr 27, 2008
627
628
629
630
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
631
632
633
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
634
635
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
636
637
638
639
640
641
642
643
*/
void MOJOSHADER_glSetPixelShaderUniformF(unsigned int idx, const float *data,
unsigned int vec4count);
/*
* The equivalent of MOJOSHADER_glSetVertexShaderUniformI() for pixel
* shaders. Other than using a different internal array that is specific
* to pixel shaders, this functions just like its vertex array equivalent.
Apr 27, 2008
Apr 27, 2008
644
645
646
647
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
648
649
650
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
651
652
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
653
654
655
656
657
658
659
660
*/
void MOJOSHADER_glSetPixelShaderUniformI(unsigned int idx, const int *data,
unsigned int ivec4count);
/*
* The equivalent of MOJOSHADER_glSetVertexShaderUniformB() for pixel
* shaders. Other than using a different internal array that is specific
* to pixel shaders, this functions just like its vertex array equivalent.
Apr 27, 2008
Apr 27, 2008
661
662
663
664
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
665
666
667
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 28, 2008
Apr 28, 2008
668
669
*
* Uniforms are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
670
671
672
*/
void MOJOSHADER_glSetPixelShaderUniformB(unsigned int idx, const int *data,
unsigned int bcount);
Apr 26, 2008
Apr 26, 2008
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
/*
* Connect a client-side array to the currently-bound program.
*
* (usage) and (index) map to Direct3D vertex declaration values: COLOR1 would
* be MOJOSHADER_USAGE_COLOR and 1.
*
* The caller should bind VBOs before this call and treat (ptr) as an offset,
* if appropriate.
*
* MojoShader will figure out where to plug this stream into the
* currently-bound program, and enable the appropriate client-side array.
*
* (size), (type), (normalized), (stride), and (ptr) correspond to
* glVertexAttribPointer()'s parameters (in most cases, these get passed
* unmolested to that very entry point during this function).
Apr 27, 2008
Apr 27, 2008
689
690
691
692
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
693
694
695
696
697
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
*
* Vertex attributes are not shared between contexts.
Apr 26, 2008
Apr 26, 2008
698
699
700
701
702
703
704
705
706
707
708
709
*/
void MOJOSHADER_glSetVertexAttribute(MOJOSHADER_usage usage,
int index, unsigned int size,
MOJOSHADER_attributeType type,
int normalized, unsigned int stride,
const void *ptr);
/*
* Inform MojoShader that it should commit any pending state to the GL. This
* must be called after you bind a program and update any inputs, right
* before you start drawing, so any outstanding changes made to the shared
* constants array (etc) can propagate to the shader during this call.
Apr 27, 2008
Apr 27, 2008
710
711
712
713
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
714
715
716
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 26, 2008
Apr 26, 2008
717
718
719
720
721
722
723
*/
void MOJOSHADER_glProgramReady(void);
/*
* Free the resources of a linked program. This will delete the GL object
* and free memory.
*
Apr 26, 2008
Apr 26, 2008
724
725
* If the program is currently bound by MOJOSHADER_glBindProgram(), it will
* be deleted as soon as it becomes unbound.
Apr 27, 2008
Apr 27, 2008
726
727
728
729
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
730
731
732
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 26, 2008
Apr 26, 2008
733
*/
Apr 26, 2008
Apr 26, 2008
734
void MOJOSHADER_glDeleteProgram(MOJOSHADER_glProgram *program);
Apr 26, 2008
Apr 26, 2008
735
736
737
738
739
/*
* Free the resources of a compiled shader. This will delete the GL object
* and free memory.
*
Apr 26, 2008
Apr 26, 2008
740
741
* If the shader is currently referenced by a linked program, it will
* be deleted as soon as all referencing programs are deleted, too.
Apr 27, 2008
Apr 27, 2008
742
743
744
745
*
* This call is NOT thread safe! As most OpenGL implementations are not thread
* safe, you should probably only call this from the same thread that created
* the GL context.
Apr 28, 2008
Apr 28, 2008
746
747
748
*
* This call requires a valid MOJOSHADER_glContext to have been made current,
* or it will crash your program. See MOJOSHADER_glMakeContextCurrent().
Apr 26, 2008
Apr 26, 2008
749
*/
Apr 26, 2008
Apr 26, 2008
750
void MOJOSHADER_glDeleteShader(MOJOSHADER_glShader *shader);
Apr 26, 2008
Apr 26, 2008
751
752
753
754
/*
* Deinitialize MojoShader's OpenGL shader management.
*
Apr 28, 2008
Apr 28, 2008
755
756
757
758
* You must call this once, while your GL context (not MojoShader context) is
* still current, if you previously had a successful call to
* MOJOSHADER_glCreateContext(). This should be the last MOJOSHADER_gl*
* function you call until you've prepared a context again.
Apr 26, 2008
Apr 26, 2008
759
760
761
762
763
764
765
*
* This will clean up resources previously allocated, and may call into the GL.
*
* This will not clean up shaders and programs you created! Please call
* MOJOSHADER_glDeleteShader() and MOJOSHADER_glDeleteProgram() to clean
* those up before calling this function!
*
Apr 28, 2008
Apr 28, 2008
766
767
768
* This function destroys the MOJOSHADER_glContext you pass it. If it's the
* current context, then no context will be current upon return.
*
Apr 26, 2008
Apr 26, 2008
769
770
771
772
773
* This call is NOT thread safe! There must not be any other MOJOSHADER_gl*
* functions running when this is called. Also, as most OpenGL implementations
* are not thread safe, you should probably only call this from the same
* thread that created the GL context.
*/
Apr 28, 2008
Apr 28, 2008
774
void MOJOSHADER_glDestroyContext(MOJOSHADER_glContext *ctx);
Apr 26, 2008
Apr 26, 2008
775
Feb 10, 2008
Feb 10, 2008
776
777
778
779
780
781
#ifdef __cplusplus
}
#endif
#endif /* include-once blocker. */
Mar 22, 2008
Mar 22, 2008
782
/* end of mojoshader.h ... */