reformat, clean-up comments

This commit is contained in:
Brian 2007-02-02 16:12:20 -07:00
parent 1f9def3163
commit e1b47b68ec

View file

@ -28,21 +28,21 @@
#include "slang_compile.h"
#include "slang_typeinfo.h"
#if defined __cplusplus
extern "C" {
#endif
/*
* Program variable data storage is kept completely transparent to the front-end compiler. It is
* up to the back-end how the data is actually allocated. The slang_storage_type enum
* provides the basic information about how the memory is interpreted. This abstract piece
* of memory is called a data slot. A data slot of a particular type has a fixed size.
* Program variable data storage is kept completely transparent to the
* front-end compiler. It is up to the back-end how the data is
* actually allocated. The slang_storage_type enum provides the basic
* information about how the memory is interpreted. This abstract
* piece of memory is called a data slot. A data slot of a particular
* type has a fixed size.
*
* For now, only the three basic types are supported, that is bool, int and float. Other built-in
* types like vector or matrix can easily be decomposed into a series of basic types.
* For now, only the three basic types are supported, that is bool,
* int and float. Other built-in types like vector or matrix can
* easily be decomposed into a series of basic types.
*
* If the vec4 module is enabled, 4-component vectors of floats are used when possible. 4x4 matrices
* are constructed of 4 vec4 slots.
* If the vec4 module is enabled, 4-component vectors of floats are
* used when possible. 4x4 matrices are constructed of 4 vec4 slots.
*/
typedef enum slang_storage_type_
{
@ -55,42 +55,50 @@ typedef enum slang_storage_type_
slang_stor_vec4
} slang_storage_type;
/*
* The slang_storage_array structure groups data slots of the same type into an array. This
* array has a fixed length. Arrays are required to have a size equal to the sum of sizes of its
* elements. They are also required to support indirect addressing. That is, if B references
* first data slot in the array, S is the size of the data slot and I is the integral index that
* is not known at compile time, B+I*S references I-th data slot.
/**
* The slang_storage_array structure groups data slots of the same
* type into an array. This array has a fixed length. Arrays are
* required to have a size equal to the sum of sizes of its
* elements. They are also required to support indirect
* addressing. That is, if B references first data slot in the array,
* S is the size of the data slot and I is the integral index that is
* not known at compile time, B+I*S references I-th data slot.
*
* This structure is also used to break down built-in data types that are not supported directly.
* Vectors, like vec3, are constructed from arrays of their basic types. Matrices are formed of
* an array of column vectors, which are in turn processed as other vectors.
* This structure is also used to break down built-in data types that
* are not supported directly. Vectors, like vec3, are constructed
* from arrays of their basic types. Matrices are formed of an array
* of column vectors, which are in turn processed as other vectors.
*/
typedef struct slang_storage_array_
{
slang_storage_type type;
struct slang_storage_aggregate_ *aggregate; /* slang_stor_aggregate */
GLuint length;
slang_storage_type type;
struct slang_storage_aggregate_ *aggregate;
GLuint length;
} slang_storage_array;
GLboolean slang_storage_array_construct (slang_storage_array *);
GLvoid slang_storage_array_destruct (slang_storage_array *);
/*
* The slang_storage_aggregate structure relaxes the indirect addressing requirement for
* slang_storage_array structure. Aggregates are always accessed statically - its member
* addresses are well-known at compile time. For example, user-defined types are implemented as
* aggregates. Aggregates can collect data of a different type.
/**
* The slang_storage_aggregate structure relaxes the indirect
* addressing requirement for slang_storage_array
* structure. Aggregates are always accessed statically - its member
* addresses are well-known at compile time. For example, user-defined
* types are implemented as aggregates. Aggregates can collect data of
* a different type.
*/
typedef struct slang_storage_aggregate_
{
slang_storage_array *arrays;
GLuint count;
slang_storage_array *arrays;
GLuint count;
} slang_storage_aggregate;
GLboolean slang_storage_aggregate_construct (slang_storage_aggregate *);
GLvoid slang_storage_aggregate_destruct (slang_storage_aggregate *);
extern GLboolean
_slang_aggregate_variable(slang_storage_aggregate *agg,
slang_type_specifier *spec,
@ -98,9 +106,6 @@ _slang_aggregate_variable(slang_storage_aggregate *agg,
slang_function_scope *funcs,
slang_struct_scope *structs,
slang_variable_scope *vars,
#if 0
slang_assembly_file *file,
#endif
slang_atom_pool *atoms);
/*
@ -111,23 +116,24 @@ _slang_aggregate_variable(slang_storage_aggregate *agg,
extern GLuint
_slang_sizeof_type (slang_storage_type);
/*
/**
* Returns total size (in machine units) of the given aggregate.
* Returns 0 on error.
*/
GLuint _slang_sizeof_aggregate (const slang_storage_aggregate *);
extern GLuint
_slang_sizeof_aggregate (const slang_storage_aggregate *);
/*
* Converts structured aggregate to a flat one, with arrays of generic type being
* one-element long.
* Returns GL_TRUE on success.
* Returns GL_FALSE otherwise.
/**
* Converts structured aggregate to a flat one, with arrays of generic
* type being one-element long. Returns GL_TRUE on success. Returns
* GL_FALSE otherwise.
*/
GLboolean _slang_flatten_aggregate (slang_storage_aggregate *, const slang_storage_aggregate *);
extern GLboolean
_slang_flatten_aggregate (slang_storage_aggregate *,
const slang_storage_aggregate *);
#ifdef __cplusplus
}
#endif
#endif