Reference GL Shapes

Reference manual - glshapes

Updated for Snowmix 0.5.0

This is the reference manual for Snowmix for the commands belonging to the glshape commands for creating, inspecting and manipulating glshapes. Glshapes can be seen as a wrapper giving access to OpenGL Graphic Primitives. See also other reference manuals:

• Reserved Commands overview
• Reference manual for general commands
• Reference manual for command macros
• Reference manual for audio feed commands. See also Audio.
• Reference manual for audio mixer commands. See also Audio.
• Reference manual for audio sink commands. See also Audio.
• Reference manual for feed commands.
• Reference manual for text commands. See also Video Text and Snowmix Tutorials on text.
• Reference manual for image commands.
• Reference manual for shape commands. See the manual page on Shapes.
• Reference manual for placed shapes.
• Reference manual for Cairo Graphics Primitives used in shapes
• Reference manual for virtual feed commands.
• Reference manual for glshapes commands.
• Reference manual for placed glshapes commands.

Overview

In the following NOE = "No OpenGL equivalent"

• glshape add - Add a place holder for a glshape or list created glshapes. NOE.
• glshape arcxz - Within a glshape draw a 3D arc xz plane. NOE.
• glshape arcyz - Within a glshape draw a 3D arc yz plane. NOE.
• glshape begin - Within a glshape start delimiter of the vertices of a primitive or a group of like primitives. glBegin().
• glshape blendfunc - Within a glshape specify pixel arithmetic. glBlendFunc().
• glshape clear - Within a glshape clear buffers to preset values. glClear().
• glshape clearcolor - Within a glshape specify clear values for the color buffers. glClearColor().
• glshape color - Within a glshape set the current color and possibly alpha. glColor().
• glshape context - Specify which OpenGL context to use. NOE.
• glshape disable - Within a glshape disable server-side GL capabilities. glDisable().
• glshape enable - Within a glshape enable server-side GL capabilities. glEnable().
• glshape end - Within a glshape end delimiter of the vertices of a primitive or a group of like primitives. glEnd().
• glshape entry - Activate or inactivate an entry in a glshape. NOE.
• glshape finish - Within a glshape block until all GL execution is complete. glFinish().
• glshape flush - Within a glshape force execution of GL commands in finite time. glFlush().
• glshape glucylinder - Within a glshape draw a cylinder. gluCylinder().
• glshape gludisk - Within a glshape draw a disk. gluDisk().
• glshape gludrawstyle - Within a glshape specify the draw style desired for quadrics. gluQuadricDrawStyle().
• glshape glunormals - Within a glshape specify what kind of normals are desired for quadrics. gluQuadricNormals().
• glshape gluorientation - Within a glshape specify inside/outside orientation for quadrics. gluQuadricOrientation().
• glshape glupartialdisk - Within a glshape draw an arc of a disk. gluPartialDisk().
• glshape gluperspective - Within a glshape set up a perspective projection matrix. gluPerspective().
• glshape glusphere - Within a glshape draw a sphere. gluSphere().
• glshape glutexture - Within a glshape specify if texturing is desired for quadrics. gluQuadricTexture().
• glshape if (osmesa|glx) - Within a glshape conditional execution of a glshape command depending on OpenGL context type. NOE.
• glshape info - List glshape info data. NOE.
• glshape inshape - Within a glshape include a glshape. NOE.
• glshape light - Within a glshape set light source parameters. glLightf().
• glshape lightv - Within a glshape set light source vector parameters. glLightfv().
• glshape loadidentity - Within a glshape replace the current matrix with the identity matrix. glLoadIdentity().
• glshape materialv - Within a glshape specify materialvector parameters for the lighting model. glmaterialfv().
• glshape matrixmode - Within a glshape set matrix mode to either projection, modelview, texture or color. glMatrixMode().
• glshape modify - Modify parameters within an entry in a glshape. NOE.
• glshape moveentry - Move or delete an entry in a glshape. NOE
• glshape normal - Within a glshape set the current normal vector. glNormal().
• glshape noop - Within a glshape add an entry with no effect. NOE.
• glshape ortho - Within a glshape multiply the current matrix with an orthographic matrix. glOrtho().
• glshape popmatrix - Within a glshape pop the current matrix stack. glPopMatrix().
• glshape pushmatrix - Within a glshape push the current matrix stack. glPushMatrix().
• glshape recursion - Within a glshape change the maximum allowed recursion level. NOE.
• glshape rotate - Within a glshape multiply the current matrix by a rotation matrix. glRotate().
• glshape scale - Within a glshape multiply the current matrix by a general scaling matrix. glScale().
• glshape scissor - Within a glshape define the scissor box. glScissor().
• glshape shademodel - Within a glshape select flat or smooth shading. glShadeModel().
• glshape snowmix - Within a glshape execute a Snowmix command. NOE.
• glshape translate - Within a glshape multiply the current matrix by a translation matrix. glTranslate().
• glshape texcoord - Within a glshape set the current texture 1D/2D/3D/4D coordinates. glTexCoord().
• glshape texfilter2d - Within a glshape setting the min and mag filter for texture. glTexParameteri() for MIN_FILTER and MAG_FILTER.
• glshape texture add - Create/delete a place holder for a texture or list created textures. NOE.
• glshape texture bind - Within a glshape bind a texture. glGenTextures(), glBindtexture(), glTexImage2D(), gluBuild2DMipmaps(), glTexParameteri().
• glshape texture source - Set source of a texture. NOE.
• glshabe vbo add - Create/delete a place holder for a Vertex Buffer Object or list craeated VBOs. No simple OpenGL equivalent.
• glshabe vbo config - Define the configuration of a Vertex Buffer Object. No simple OpenGL equivalent.
• glshabe vbo data - Define the data set for a configured VBO. No simple OpenGL equivalent.
• glshabe vbo indices - Define the indices of the data set for a configured VBO. No simple OpenGL equivalent.
• glshabe vbo - Within a glshape include a VBO. No simple OpenGL equivalent.
• glshape vector add - Create/delete a vector place holder or list created vectors. NOE.
• glshape vector value - Set the values of a 2, 3 and 4 dimensional vector. NOE.
• glshape verbose - Set the verbose level for gl COpenGLVideo Class.
• glshape vertex - Within a glshape specify a 1D, 2D, 3D or 4D vertex. glVertex().
• glshape help form - List valid <form> parameters. NOE.
• glshape help mode - List valid <mode> parameters. NOE.
• glshape help factor - List valid <factor> parameters. NOE.
• glshape help filter - List valid <near filter> and <mag filter> parameters. NOE.
• glshape help light - List valid parameters for light. NOE.
• glshape help modify - List the type of glshape entries that can be changed with the glshape modify command. NOE.

Syntax Overview

• glshape add [<glshape id> [<shape name>]]
• glshape (arcxz | arcyz) <glshape id> <angle> <aspect> <slices> <texleft> <texright> <textop> <texbottom>
• glshape begin <glshape id> <form>
• glshape blendfunc <glshape id> <s factor> <d factor>
• glshape clear <glshape id> (depth | color | color+depth)
• glshape clearcolor <glshape id> <red> <green> <blue> [<alpha>]
• glshape color <glshape id> <red> <green> <blue> [<alpha>]
• glshape context [(osmesa|glx|auto)]
• glshape disable <glshape id> <mode>
• glshape enable <glshape id> <mode>
• glshape end <glshape id>
• glshape entry <glshape id> (active|inactivate|number)
• glshape finish <glshape id>
• glshape flush <glshape id>
• glshape glucylinder <glshape id> <quad id> <base> <top> <height> <slices> <stacks>
• glshape gludisk <quad id> <inner> <outer> <slices> <loops>
• glshape glupartialdisk <quad id> <inner> <outer> <slices> <loops> <start> <sweep>
• glshape gludrawstyle <glshape id> <quad id> (fill|line|point|silhouette)
• glshape glunormals <glshape id> <quad id> (none|flat|smooth)
• glshape gluorientation <glshape id> <quad id> (outside|inside)
• glshape glupartialdisk <quad id> <inner> <outer> <slices> <loops> <start> <sweep>
• glshape gluperspective <glshape id> <fovy> <aspect> <znear> <zfar>
• glshape glusphere <glshape id> <quad id> <radius> <slices> <stacks>
• glshape glutexture <glshape id> <quad id> (0|1)
• glshape if (osmesa|glx) <glshape id> <glshape command>
• glshape info
• glshape inshape <glshape id> <inglshape id>
• glshape light <shape id> <gllight i> <pname> <vector id>
• glshape lightv <shape id> <gllight i> <pname> <vector id>
• glshape loadidentity <glshape id>
• glshape materialv <glshape id> <face> <pname> <vector id>
• glshape matrixmode <glshape id> (projection | modelview | texture | color)
• glshape modify <glshape id> <line> (<no>[,<no>...] (<value> | values>)
• glshape moveentry <shape id> <entry id> [<to entry>]
• glshape normal <glshape id> <x> <y> <z>
• glshape noop <glshape id>
• glshape ortho <glshape id> <left> <right> <bottom> <top> <near> <far>
• glshape popmatrix <glshape id>
• glshape pushmatrix <glshape id>
• glshape recursion <glshape id> <level>
• glshape rotate <glshape id> <angle> <x> <y> <z>
• glshape scale <glshape id> <scale x> <scale y> <scale z>
• glshape scissor <glshape id> <x> <y> <width> <height>
• glshape shademodel <glshape id> (flat|smooth)
• glshape snowmix <glshape id> <snowmix command>
• glshape translate <glshape id> <x> <y> <z>
• glshape texcoord <glshape id> <s> [<r> [<t> [<q>]]]
• glshape texfilter2d <glshape id> <near filter> <mag filter>
• glshape texture add [<texture id> [<texture name>]]
• glshape texture bind <glshape id> <texture id> [<min> <mag>] [(2d | cube)]
• glshape texture source [<texture id> (feed <feed id>|frame <frame id>|image <image id>)|none [<id>]]
• glshabe vbo add <vbo id> <name>
• glshabe vbo config <vbo id> [(static|dynamic|stream) <form> (c3 | c4 | n3 | t1 | t2 | t3 | t4 | v2 | v3 | v4) ...]
• glshabe vbo data <vbo id> [<data 0> <data 1> ...]
• glshabe vbo indices <vbo id> [<index 0> <index 1> ...]
• glshabe vbo <glshape id> <vbo id>
• glshape vector add [<vector id> [<vector name>]]
• glshape vector value [<vector id> <a> <b> [<c> [<d>]]]
• glshape verbose [<level>]
• glshape vertex <glshape id> <x> [<y> [<z> [<w>]]]
• glshape help [form | mode | filter | factor | light | modify]

  The <form> parameter:
  <form> = lines  | line_strip  | line_loop 
  <form> = points  | polygon  | quad_strip
  <form> = quads  | triangles  | triangle_strip
  <form> = triangle_fan
  
  The <mode> parameter:
  <mode> = depth_test  | blend  | texture_2d | normalize  | lighting  | clip_plane0 
  <mode> = light0  | alpha_test  | auto_normal | clip_plane1  | clip_plane2
  <mode> = clip_plane3 | clip_plane4  | clip_plane5  | color_logic_op 
  <mode> = color_material  | color_sum  | color_table
  <mode> = convolution_1d  | convolution_2d  | cull_face
  <mode> = dither  | fog  | histogram | index_logic_op  | light1  | light2
  <mode> = light3  | light4  | light5 | light6  | light7  | line_smooth 
  <mode> = line_stipple  | map1_color_4  | map1_index 
  <mode> = map1_normal  | map1_texture_coord_1  | map1_texture_coord_2
  <mode> = map1_texture_coord_3  | map1_texture_coord_4  | map1_vertex_3
  <mode> = map1_vertex_4  | map2_color_4  | map2_index 
  <mode> = map2_normal  | map2_texture_coord_1  | map2_texture_coord_2
  <mode> = map2_texture_coord_3  | map2_texture_coord_4  | map2_vertex_3
  <mode> = map2_vertex_4  | minmax  | multisample   
  <mode> = point_smooth  | point_sprite  | polygon_offset_fill 
  <mode> = polygon_offset_point  | polygon_smooth  | polygon_stipple 
  <mode> = post_color_matrix_color_table  | post_convolution_color_table  | rescale_normal
  <mode> = sample_alpha_to_coverage  | sample_alpha_to_one  | sample_coverage
  <mode> = separable_2d  | scissor_test  | stencil_test 
  <mode> = texture_1d  | texture_3d  | texture_cube_map 
  <mode> = texture_gen_q  | texture_gen_r  | texture_gen_s
  <mode> = texture_gen_t  | vertex_program_point_size  | vertex_program_two_side
  
  The <near filter> and <mag filter> parameter:
  <near filter> = nearest | linear
  <mag filter> = nearest | linear
  
  The <factor> parameter:
  <factor> = zero  | one  | src_color 
  <factor> = one_minus_src_color  | dst_color  | one_minus_dst_color 
  <factor> = src_alpha  | one_minus_src_alpha  | dst_alpha  
  <factor> = one_minus_dst_alpha  | constant_color  | one_minus_constant_color
  <factor> = constant_alpha  | one_minus_constant_alpha  | src_alpha_saturate