Skip to content

Commit e5b7d17

Browse files
devel-chmdevel-chm
committed
Add XS working directories with usage.txt
This puts the corresponding annotation information into the appropriate directories for XS bindings to be developer. The idea is to implement separate XS file and then include them for output from the generate-XS.pl stage of configuration.
1 parent be877fe commit e5b7d17

File tree

19 files changed

+614
-0
lines changed

19 files changed

+614
-0
lines changed

Diff for: ‎utils/priority_xs/NOTES.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
* This file contains working notes from XS code generation
2+
3+
* utils/priority_xs/ Directory contents:
4+
5+
NOTES.txt - this file
6+
glDeleteXxxx/ - directory with XS work for glDelete routines
7+
glGenXxxx/ - directory with XS work for glGen routines
8+
required-bad-csv.txt - annotations for priority "bad" routines with pointers
9+
10+
* glDelete* and glGen* routines have the same calling convention save
11+
that the glDelete takes a pointer to n object ids to be deleted while
12+
glGen take a pointer argument to a buffer large enough to recieve n
13+
generated object ids.

Diff for: ‎utils/priority_xs/glBufferData/usage.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
GL_VERSION_1_5.0001.csv, glBufferData, 0,0,GLenum,target,N/A,in,fixed,N/A
2+
GL_VERSION_1_5.0001.csv, glBufferData, 1,0,GLsizeiptr,size,N/A,in,fixed,"number of bytes in data"
3+
GL_VERSION_1_5.0001.csv, glBufferData, 2,1,"const void *",data,arg1(size),in,variable,"either pointer to size bytes of data or NULL (should we implement NULL or use 0?)"
4+
GL_VERSION_1_5.0001.csv, glBufferData, 3,0,GLenum,usage,N/A,in,fixed,N/A
5+
GL_VERSION_1_5.0001.csv, glBufferData, -1,0,void,N/A,N/A,out,fixed,N/A
6+
GL_ARB_vertex_buffer_object.csv,glBufferDataARB, 0,0,GLenum,target,N/A,in,fixed,N/A
7+
GL_ARB_vertex_buffer_object.csv,glBufferDataARB, 1,0,GLsizeiptrARB,size,N/A,in,fixed,"number of bytes in data"
8+
GL_ARB_vertex_buffer_object.csv,glBufferDataARB, 2,1,"const void *",data,arg1(size),in,variable,"either pointer to size bytes of data or NULL (should we implement NULL or use 0?)"
9+
GL_ARB_vertex_buffer_object.csv,glBufferDataARB, 3,0,GLenum,usage,N/A,in,fixed,N/A
10+
GL_ARB_vertex_buffer_object.csv,glBufferDataARB,-1,0,void,N/A,N/A,out,fixed,N/A

Diff for: ‎utils/priority_xs/glDeleteXxxx/required-delete-objects.txt renamed to ‎utils/priority_xs/glDeleteXxxx/usage.txt

File renamed without changes.

Diff for: ‎utils/priority_xs/glDrawPixels/usage.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GL_VERSION_1_1.0003.csv, glDrawPixels,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_1_1.0003.csv, glDrawPixels,0,0,GLsizei,width,N/A,in,fixed,N/A
3+
GL_VERSION_1_1.0003.csv, glDrawPixels,1,0,GLsizei,height,N/A,in,fixed,N/A
4+
GL_VERSION_1_1.0003.csv, glDrawPixels,2,0,GLenum,format,N/A,in,fixed,"determines pixel data size/type"
5+
GL_VERSION_1_1.0003.csv, glDrawPixels,3,0,GLenum,type,N/A,in,fixed,"determines pixel data size/type"
6+
GL_VERSION_1_1.0003.csv, glDrawPixels,4,1,"const void *",pixels,N/A,in,variable,"size and type of pixels data is a complicated function of format and type"

Diff for: ‎utils/priority_xs/glGenXxxx/required-gen-objects.txt renamed to ‎utils/priority_xs/glGenXxxx/usage.txt

File renamed without changes.

Diff for: ‎utils/priority_xs/glGetActiveUniform/usage.txt

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,0,0,GLuint,program,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,1,0,GLuint,index,N/A,in,fixed,N/A
4+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,2,0,GLsizei,maxLength,N/A,in,fixed,"glGetProgramiv(GLuint program,GL_ACTIVE_UNIFORM_MAX_LENGTH,GLint *params) to determine"
5+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,3,1,"GLsizei *",length,N/A,out,fixed,"string length of arg6(name) not including NULL"
6+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,4,1,"GLint *",size,N/A,out,fixed,N/A
7+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,5,1,"GLenum *",type,N/A,out,fixed,N/A
8+
GL_VERSION_2_0.0001.csv, glGetActiveUniform,6,1,"GLchar *",name,arg2(maxLength),out,variable,"name is a NULL terminated string"
9+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,-1,0,void,N/A,N/A,out,fixed,N/A
10+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,0,0,GLhandleARB,programObj,N/A,in,fixed,N/A
11+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,1,0,GLuint,index,N/A,in,fixed,N/A
12+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,2,0,GLsizei,maxLength,N/A,in,fixed,"glGetProgramiv(GLuint program,GL_ACTIVE_UNIFORM_MAX_LENGTH,GLint *params) to determine"
13+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,3,1,"GLsizei *",length,N/A,out,fixed,"string length of arg6(name) not including NULL"
14+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,4,1,"GLint *",size,N/A,out,fixed,N/A
15+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,5,1,"GLenum *",type,N/A,out,fixed,N/A
16+
GL_ARB_shader_objects.0001.csv, glGetActiveUniformARB,6,1,"GLcharARB *",name,arg2(maxLength),out,variable,"name is a NULL terminated string"

Diff for: ‎utils/priority_xs/glGetAttribLocation/usage.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GL_VERSION_2_0.0002.csv, glGetAttribLocation,-1,0,GLint,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0002.csv, glGetAttribLocation,0,0,GLuint,program,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0002.csv, glGetAttribLocation,1,1,"const GLchar *",name,N/A,in,N/A,"Null terminated string so size info not needed to call"
4+
GL_ARB_vertex_shader.csv, glGetAttribLocationARB,-1,0,GLint,N/A,N/A,out,fixed,N/A
5+
GL_ARB_vertex_shader.csv, glGetAttribLocationARB,0,0,GLhandleARB,programObj,N/A,in,fixed,N/A
6+
GL_ARB_vertex_shader.csv, glGetAttribLocationARB,1,1,"const GLcharARB *",name,N/A,in,N/A,"Null terminated string so size info not needed to call"

Diff for: ‎utils/priority_xs/glGetIntegerv/usage.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
GL_VERSION_1_1.0004.csv, glGetIntegerv,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_1_1.0004.csv, glGetIntegerv,0,0,GLenum,pname,N/A,in,fixed,"determines count and type of params returned"
3+
GL_VERSION_1_1.0004.csv, glGetIntegerv,1,1,"GLint *",params,"1,2,4,GL_NUM_COMPRESSED_TEXTURE_FORMATS,GL_NUM_PROGRAM_BINARY_FORMATS",out,variable,"Depends on pname input, use hash to lookup"

Diff for: ‎utils/priority_xs/glGetProgramiv/usage.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
GL_VERSION_2_0.0002.csv, glGetProgramiv,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0002.csv, glGetProgramiv,0,0,GLuint,program,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0002.csv, glGetProgramiv,1,0,GLenum,pname,N/A,in,fixed,"returns 1 value except for GL_WORK_GROUP_SIZE which has 3 return values"
4+
GL_VERSION_2_0.0002.csv, glGetProgramiv,2,1,"GLint *",param,"1,3",out,variable,"Count determined by arg1(pname)"
5+
GL_ARB_vertex_program.0001.csv, glGetProgramivARB,-1,0,void,N/A,N/A,out,fixed,N/A
6+
GL_ARB_vertex_program.0001.csv, glGetProgramivARB,0,0,GLenum,target,N/A,in,fixed,N/A
7+
GL_ARB_vertex_program.0001.csv, glGetProgramivARB,1,0,GLenum,pname,N/A,in,fixed,"returns 1 value except for GL_WORK_GROUP_SIZE which has 3 return values"
8+
GL_ARB_vertex_program.0001.csv, glGetProgramivARB,2,1,"GLint *",params,"1,3",out,variable,"Count determined by arg1(pname)"
9+
GL_NV_vertex_program.0001.csv, glGetProgramivNV,-1,0,void,N/A,N/A,out,fixed,N/A
10+
GL_NV_vertex_program.0001.csv, glGetProgramivNV,0,0,GLuint,id,N/A,in,fixed,N/A
11+
GL_NV_vertex_program.0001.csv, glGetProgramivNV,1,0,GLenum,pname,N/A,in,fixed,"returns 1 value except for GL_WORK_GROUP_SIZE which has 3 return values"
12+
GL_NV_vertex_program.0001.csv, glGetProgramivNV,2,1,"GLint *",params,"1,3",out,variable,"Count determined by arg1(pname)"

Diff for: ‎utils/priority_xs/glGetShaderiv/usage.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
GL_VERSION_2_0.0002.csv, glGetShaderiv,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0002.csv, glGetShaderiv,0,0,GLuint,shader,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0002.csv, glGetShaderiv,1,0,GLenum,pname,N/A,in,fixed,N/A
4+
GL_VERSION_2_0.0002.csv, glGetShaderiv,2,1,"GLint *",param,1,out,fixed,N/A

Diff for: ‎utils/priority_xs/glGetUniformLocation/usage.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GL_VERSION_2_0.0002.csv, glGetUniformLocation,-1,0,GLint,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0002.csv, glGetUniformLocation,0,0,GLuint,program,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0002.csv, glGetUniformLocation,1,1,"const GLchar *",name,N/A,in,variable,"name is a NULL terminated string"
4+
GL_ARB_shader_objects.0002.csv, glGetUniformLocationARB,-1,0,GLint,N/A,N/A,out,fixed,N/A
5+
GL_ARB_shader_objects.0002.csv, glGetUniformLocationARB,0,0,GLhandleARB,programObj,N/A,in,fixed,N/A
6+
GL_ARB_shader_objects.0002.csv, glGetUniformLocationARB,1,1,"const GLcharARB *",name,N/A,in,variable,"name is a NULL terminated string"

Diff for: ‎utils/priority_xs/glGetXxxxInfoLog/usage.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
GL_VERSION_2_0.0002.csv, glGetProgramInfoLog,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_VERSION_2_0.0002.csv, glGetProgramInfoLog,0,0,GLuint,program,N/A,in,fixed,N/A
3+
GL_VERSION_2_0.0002.csv, glGetProgramInfoLog,1,0,GLsizei,bufSize,N/A,in,fixed,"glGetProgramiv(GLuint program,GL_INFO_LOG_LENGTH,GLint *params) to determine"
4+
GL_VERSION_2_0.0002.csv, glGetProgramInfoLog,2,1,"GLsizei *",length,N/A,inout,fixed,"string length of arg3(infoLog) not including NULL"
5+
GL_VERSION_2_0.0002.csv, glGetProgramInfoLog,3,1,"GLchar *",infoLog,arg1(bufSize),out,variable,"infoLog is returned as NULL terminated string"
6+
GL_VERSION_2_0.0002.csv, glGetShaderInfoLog,-1,0,void,N/A,N/A,out,fixed,N/A
7+
GL_VERSION_2_0.0002.csv, glGetShaderInfoLog,0,0,GLuint,shader,N/A,in,fixed,N/A
8+
GL_VERSION_2_0.0002.csv, glGetShaderInfoLog,1,0,GLsizei,bufSize,N/A,in,fixed,"glGetShaderiv(GLuint shader,GL_INFO_LOG_LENGTH,GLint *params) to determine"
9+
GL_VERSION_2_0.0002.csv, glGetShaderInfoLog,2,1,"GLsizei *",length,N/A,inout,fixed,"string length of arg3(infoLog) not including NULL"
10+
GL_VERSION_2_0.0002.csv, glGetShaderInfoLog,3,1,"GLchar *",infoLog,arg1(bufSize),out,variable,"infoLog is returned as NULL terminated string"

Diff for: ‎utils/priority_xs/glObjectLabel/usage.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
GL_KHR_debug.0002.csv, glObjectLabel,-1,0,void,N/A,N/A,out,fixed,N/A
2+
GL_KHR_debug.0002.csv, glObjectLabel,0,0,GLenum,identifier,N/A,in,fixed,N/A
3+
GL_KHR_debug.0002.csv, glObjectLabel,1,0,GLuint,name,N/A,in,fixed,N/A
4+
GL_KHR_debug.0002.csv, glObjectLabel,2,0,GLsizei,length,N/A,in,fixed,"number of chars in label, negative value mean NULL terminated, NULL input clears any debug label"
5+
GL_KHR_debug.0002.csv, glObjectLabel,3,1,"const GLchar *",label,"arg2(length) determines",in,variable,"use label=NULL and null terminated string input"

0 commit comments

Comments
 (0)