From: TravisCI-DocBuilder Date: Sat, 5 Dec 2015 12:30:43 +0000 (+0000) Subject: Doc generated from commit c048221f866052fe4c3762bb321d0ed6827ed459 X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=7f9cfd9db67d61c46afdf3d57a4d6292a4f1c8f7;p=corbenik%2Fctrulib.git Doc generated from commit c048221f866052fe4c3762bb321d0ed6827ed459 --- diff --git a/functions_g.html b/functions_g.html index 6cefc68..db77372 100644 --- a/functions_g.html +++ b/functions_g.html @@ -139,6 +139,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

geoShaderInputStride : shaderProgram_s

geoShaderMode +: shaderProgram_s +

gfx : ConsoleFont

diff --git a/functions_vars_g.html b/functions_vars_g.html index 75113dd..a837d43 100644 --- a/functions_vars_g.html +++ b/functions_vars_g.html @@ -139,6 +139,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

geoShaderInputStride : shaderProgram_s

geoShaderMode +: shaderProgram_s +

gfx : ConsoleFont

diff --git a/globals_defs_g.html b/globals_defs_g.html index 5089253..de2cc03 100644 --- a/globals_defs_g.html +++ b/globals_defs_g.html @@ -1326,9 +1326,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_02FF : registers.h

GPUREG_ALPHATEST_CONFIG -: registers.h -

GPUREG_ATTRIBBUFFER0_CONFIG1 : registers.h

@@ -1449,11 +1446,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_BLEND_COLOR : registers.h

GPUREG_BLEND_CONFIG -: registers.h -

GPUREG_BLEND_ENABLE -: registers.h +

GPUREG_BLEND_FUNC +: registers.h

GPUREG_CMDBUF_ADDR0 : registers.h @@ -1473,6 +1467,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_CMDBUF_SIZE1 : registers.h

GPUREG_COLOR_OPERATION +: registers.h +

GPUREG_COLORBUFFER_FORMAT : registers.h

@@ -1485,6 +1482,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_COLORBUFFER_WRITE : registers.h

GPUREG_DEPTH_COLOR_MASK +: registers.h +

GPUREG_DEPTHBUFFER_FORMAT : registers.h

@@ -1506,9 +1506,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_DEPTHMAP_SCALE : registers.h

GPUREG_DEPTHTEST_CONFIG -: registers.h -

GPUREG_DRAWARRAYS : registers.h

@@ -1578,6 +1575,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_FOG_LUT_INDEX : registers.h

GPUREG_FRAGOP_ALPHA_TEST +: registers.h +

GPUREG_FRAGOP_CLIP : registers.h

@@ -2019,8 +2019,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_LIGHTING_NUM_LIGHTS : registers.h

GPUREG_LOGICOP_CONFIG -: registers.h +

GPUREG_LOGIC_OP +: registers.h

GPUREG_NUMVERTICES : registers.h @@ -2106,8 +2106,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

GPUREG_START_DRAW_FUNC0 : registers.h

GPUREG_STENCIL_ACTION -: registers.h +

GPUREG_STENCIL_OP +: registers.h

GPUREG_STENCIL_TEST : registers.h diff --git a/globals_enum.html b/globals_enum.html index 47e895b..4ae9e5a 100644 --- a/globals_enum.html +++ b/globals_enum.html @@ -257,6 +257,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

- g -

geoShaderMode +: shaderProgram.h +
gfx3dSide_t : gfx.h
GPU_ZERO : enums.h
GSH_NORMAL +: shaderProgram.h +
GSH_PARTICLE +: shaderProgram.h +
GSH_SUBDIVISION_CATMULL_CLARK +: shaderProgram.h +
GSH_SUBDIVISION_LOOP +: shaderProgram.h +
GSP_BGR8_OES : gspgpu.h
shaderProgramSetGshInputPermutation() : shaderProgram.h
shaderProgramSetGshMode() +: shaderProgram.h +
shaderProgramSetVsh() : shaderProgram.h
GEOMETRY_SHDR : shbin.h
geoShaderMode +: shaderProgram.h +
GET_VERSION_MAJOR : os.h
GPUREG_02FF : registers.h
GPUREG_ALPHATEST_CONFIG -: registers.h -
GPUREG_ATTRIBBUFFER0_CONFIG1 : registers.h
GPUREG_BLEND_COLOR : registers.h
GPUREG_BLEND_CONFIG -: registers.h -
GPUREG_BLEND_ENABLE -: registers.h +
GPUREG_BLEND_FUNC +: registers.h
GPUREG_CMDBUF_ADDR0 : registers.h @@ -2428,6 +2425,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
GPUREG_CMDBUF_SIZE1 : registers.h
GPUREG_COLOR_OPERATION +: registers.h +
GPUREG_COLORBUFFER_FORMAT : registers.h
GPUREG_COLORBUFFER_WRITE : registers.h
GPUREG_DEPTH_COLOR_MASK +: registers.h +
GPUREG_DEPTHBUFFER_FORMAT : registers.h
GPUREG_DEPTHMAP_SCALE : registers.h
GPUREG_DEPTHTEST_CONFIG -: registers.h -
GPUREG_DRAWARRAYS : registers.h
GPUREG_FOG_LUT_INDEX : registers.h
GPUREG_FRAGOP_ALPHA_TEST +: registers.h +
GPUREG_FRAGOP_CLIP : registers.h
GPUREG_LIGHTING_NUM_LIGHTS : registers.h
GPUREG_LOGICOP_CONFIG -: registers.h +
GPUREG_LOGIC_OP +: registers.h
GPUREG_NUMVERTICES : registers.h @@ -3061,8 +3064,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
GPUREG_START_DRAW_FUNC0 : registers.h
GPUREG_STENCIL_ACTION -: registers.h +
GPUREG_STENCIL_OP +: registers.h
GPUREG_STENCIL_TEST : registers.h @@ -3340,6 +3343,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
GPUREG_VTX_FUNC : registers.h
GSH_NORMAL +: shaderProgram.h +
GSH_PARTICLE +: shaderProgram.h +
GSH_SUBDIVISION_CATMULL_CLARK +: shaderProgram.h +
GSH_SUBDIVISION_LOOP +: shaderProgram.h +
GSP_BGR8_OES : gspgpu.h
shaderProgramSetGshInputPermutation() : shaderProgram.h
shaderProgramSetGshMode() +: shaderProgram.h +
shaderProgramSetVsh() : shaderProgram.h

More...

Framebuffer registers (0x100-0x13F)

GPUREG_BLEND_ENABLE

GPUREG_BLEND_CONFIG

GPUREG_LOGICOP_CONFIG

GPUREG_COLOR_OPERATION

GPUREG_BLEND_FUNC

GPUREG_LOGIC_OP

GPUREG_BLEND_COLOR

GPUREG_ALPHATEST_CONFIG

GPUREG_FRAGOP_ALPHA_TEST

GPUREG_STENCIL_TEST

GPUREG_STENCIL_ACTION

GPUREG_DEPTHTEST_CONFIG

GPUREG_STENCIL_OP

GPUREG_DEPTH_COLOR_MASK

GPUREG_0108

274

275 ///@name Framebuffer registers (0x100-0x13F)

276 ///@{

277 #define GPUREG_BLEND_ENABLE 0x0100 ///< Blend toggle.

278 #define GPUREG_BLEND_CONFIG 0x0101 ///< Blend configuration.

279 #define GPUREG_LOGICOP_CONFIG 0x0102 ///< Logical operator configuration.

277 #define GPUREG_COLOR_OPERATION 0x0100 ///< Configures fragment operation and blend mode.

278 #define GPUREG_BLEND_FUNC 0x0101 ///< Blend function configuration.

279 #define GPUREG_LOGIC_OP 0x0102 ///< Logical operator configuration.

280 #define GPUREG_BLEND_COLOR 0x0103 ///< Blend color.

281 #define GPUREG_ALPHATEST_CONFIG 0x0104 ///< Alpha test configuration.

281 #define GPUREG_FRAGOP_ALPHA_TEST 0x0104 ///< Alpha test configuration.

282 #define GPUREG_STENCIL_TEST 0x0105 ///< Stencil test configuration.

283 #define GPUREG_STENCIL_ACTION 0x0106 ///< Stencil test action.

284 #define GPUREG_DEPTHTEST_CONFIG 0x0107 ///< Depth test configuration.

283 #define GPUREG_STENCIL_OP 0x0106 ///< Stencil test operation.

284 #define GPUREG_DEPTH_COLOR_MASK 0x0107 ///< Depth test and color mask configuration.

285 #define GPUREG_0108 0x0108 ///< Unknown.

286 #define GPUREG_0109 0x0109 ///< Unknown.

287 #define GPUREG_010A 0x010A ///< Unknown.

Data Structures | +Enumerations | Functions

shaderProgram.h File Reference

@@ -113,6 +114,21 @@ Data Structures Describes an instance of a full shader program. More...
+ + + + +

+Enumerations
enum	geoShaderMode { + GSH_NORMAL = 0, + + GSH_PARTICLE = 1, + + GSH_SUBDIVISION_LOOP = 2, + + GSH_SUBDIVISION_CATMULL_CLARK = 3 + + }
	Geometry shader operation modes. More...

@@ -145,6 +161,9 @@ Functions + + + @@ -154,7 +173,36 @@ Functions

Functions
Result	shaderInstanceInit (shaderInstance_s si, DVLE_s dvle)
Result	shaderProgramSetGshInputPermutation (shaderProgram_s *sp, u64 permutation)
	Configures the permutation of the input attributes of the geometry shader of a shader program. More...

Result	shaderProgramSetGshMode (shaderProgram_s *sp, geoShaderMode mode)
	Configures the operation mode of the geometry shader of a shader program. More...

Result	shaderProgramConfigure (shaderProgram_s *sp, bool sendVshCode, bool sendGshCode)
	Configures the shader units to use the specified shader program. More...

Detailed Description

Functions for working with shaders.

Function Documentation

Enumeration Type Documentation

+ + + + +

enum geoShaderMode

+ +

Geometry shader operation modes.

+ + + + + +

Enumerator
GSH_NORMAL	+ Normal operation. +
GSH_PARTICLE	+ Particle system. +
GSH_SUBDIVISION_LOOP	+ Loop subdivision surface. +
GSH_SUBDIVISION_CATMULL_CLARK	+ Catmull-Clark subdivision surface. +

+ +

Function Documentation

@@ -502,6 +550,41 @@ Functions +

+ + + + + + + + + + + + + + + + + + +

Result shaderProgramSetGshMode	(	shaderProgram_s *	sp,
		geoShaderMode	mode
	)

+ +

Configures the operation mode of the geometry shader of a shader program.

Parameters

+ + + +

sp	Shader program to use.
mode	Operation mode to use.

33 shaderInstance_s* geometryShader; ///< Geometry shader.

34 u32 geoShaderInputPermutation[2]; ///< Geometry shader input permutation.

35 u8 geoShaderInputStride; ///< Geometry shader input stride.

36 }shaderProgram_s;

38 /**

39 * @brief Initializes a shader instance.

40 * @param si Shader instance to initialize.

41 * @param dvle DVLE to initialize the shader instance with.

42 */

43 Result shaderInstanceInit(shaderInstance_s* si, DVLE_s* dvle);

45 /**

46 * @brief Frees a shader instance.

47 * @param si Shader instance to free.

48 */

49 Result shaderInstanceFree(shaderInstance_s* si);

51 /**

52 * @brief Sets a bool uniform of a shader.

53 * @param si Shader instance to use.

54 * @param id ID of the bool uniform.

55 * @param value Value to set.

56 */

57 Result shaderInstanceSetBool(shaderInstance_s* si, int id, bool value);

59 /**

60 * @brief Gets a bool uniform of a shader.

61 * @param si Shader instance to use.

62 * @param id ID of the bool uniform.

63 * @param value Pointer to output the value to.

64 */

65 Result shaderInstanceGetBool(shaderInstance_s* si, int id, bool* value);

67 /**

68 * @brief Gets the location of a shader's uniform.

69 * @param si Shader instance to use.

70 * @param name Name of the uniform.

71 */

72 s8 shaderInstanceGetUniformLocation(shaderInstance_s* si, const char* name);

74 /**

75 * @brief Initializes a shader program.

76 * @param sp Shader program to initialize.

77 */

78 Result shaderProgramInit(shaderProgram_s* sp);

80 /**

81 * @brief Frees a shader program.

82 * @param sp Shader program to free.

83 */

84 Result shaderProgramFree(shaderProgram_s* sp);

86 /**

87 * @brief Sets the vertex shader of a shader program.

88 * @param sp Shader program to use.

89 * @param dvle Vertex shader to set.

90 */

91 Result shaderProgramSetVsh(shaderProgram_s* sp, DVLE_s* dvle);

93 /**

94 * @brief Sets the geometry shader of a shader program.

95 * @param sp Shader program to use.

96 * @param dvle Geometry shader to set.

97 * @param stride Stride of the geometry shader.

98 */

99 Result shaderProgramSetGsh(shaderProgram_s* sp, DVLE_s* dvle, u8 stride);

100

101 /**

102 * @brief Configures the permutation of the input attributes of the geometry shader of a shader program.

103 * @param sp Shader program to use.

104 * @param permutation Attribute permutation to use.

105 */

106 Result shaderProgramSetGshInputPermutation(shaderProgram_s* sp, u64 permutation);

107

108 /**

109 * @brief Configures the shader units to use the specified shader program.

110 * @param sp Shader program to use.

111 * @param sendVshCode When true, the vertex shader's code and operand descriptors are uploaded.

112 * @param sendGshCode When true, the geometry shader's code and operand descriptors are uploaded.

113 */

114 Result shaderProgramConfigure(shaderProgram_s* sp, bool sendVshCode, bool sendGshCode);

115

116 /**

117 * @brief Same as shaderProgramConfigure, but always loading code/operand descriptors and uploading DVLE constants afterwards.

118 * @param sp Shader program to use.

119 */

120 Result shaderProgramUse(shaderProgram_s* sp);

36 u8 geoShaderMode; ///< Geometry shader operation mode.

37 }shaderProgram_s;

39 /// Geometry shader operation modes.

40 typedef enum

41 {

42 GSH_NORMAL = 0, ///< Normal operation.

43 GSH_PARTICLE = 1, ///< Particle system.

44 GSH_SUBDIVISION_LOOP = 2, ///< Loop subdivision surface.

45 GSH_SUBDIVISION_CATMULL_CLARK = 3, ///< Catmull-Clark subdivision surface.

46 } geoShaderMode;

48 /**

49 * @brief Initializes a shader instance.

50 * @param si Shader instance to initialize.

51 * @param dvle DVLE to initialize the shader instance with.

52 */

53 Result shaderInstanceInit(shaderInstance_s* si, DVLE_s* dvle);

55 /**

56 * @brief Frees a shader instance.

57 * @param si Shader instance to free.

58 */

59 Result shaderInstanceFree(shaderInstance_s* si);

61 /**

62 * @brief Sets a bool uniform of a shader.

63 * @param si Shader instance to use.

64 * @param id ID of the bool uniform.

65 * @param value Value to set.

66 */

67 Result shaderInstanceSetBool(shaderInstance_s* si, int id, bool value);

69 /**

70 * @brief Gets a bool uniform of a shader.

71 * @param si Shader instance to use.

72 * @param id ID of the bool uniform.

73 * @param value Pointer to output the value to.

74 */

75 Result shaderInstanceGetBool(shaderInstance_s* si, int id, bool* value);

77 /**

78 * @brief Gets the location of a shader's uniform.

79 * @param si Shader instance to use.

80 * @param name Name of the uniform.

81 */

82 s8 shaderInstanceGetUniformLocation(shaderInstance_s* si, const char* name);

84 /**

85 * @brief Initializes a shader program.

86 * @param sp Shader program to initialize.

87 */

88 Result shaderProgramInit(shaderProgram_s* sp);

90 /**

91 * @brief Frees a shader program.

92 * @param sp Shader program to free.

93 */

94 Result shaderProgramFree(shaderProgram_s* sp);

96 /**

97 * @brief Sets the vertex shader of a shader program.

98 * @param sp Shader program to use.

99 * @param dvle Vertex shader to set.

100 */

101 Result shaderProgramSetVsh(shaderProgram_s* sp, DVLE_s* dvle);

102

103 /**

104 * @brief Sets the geometry shader of a shader program.

105 * @param sp Shader program to use.

106 * @param dvle Geometry shader to set.

107 * @param stride Stride of the geometry shader.

108 */

109 Result shaderProgramSetGsh(shaderProgram_s* sp, DVLE_s* dvle, u8 stride);

110

111 /**

112 * @brief Configures the permutation of the input attributes of the geometry shader of a shader program.

113 * @param sp Shader program to use.

114 * @param permutation Attribute permutation to use.

115 */

116 Result shaderProgramSetGshInputPermutation(shaderProgram_s* sp, u64 permutation);

117

118 /**

119 * @brief Configures the operation mode of the geometry shader of a shader program.

120 * @param sp Shader program to use.

121 * @param mode Operation mode to use.

122 */

123 Result shaderProgramSetGshMode(shaderProgram_s* sp, geoShaderMode mode);

124

125 /**

126 * @brief Configures the shader units to use the specified shader program.

127 * @param sp Shader program to use.

128 * @param sendVshCode When true, the vertex shader's code and operand descriptors are uploaded.

129 * @param sendGshCode When true, the geometry shader's code and operand descriptors are uploaded.

130 */

131 Result shaderProgramConfigure(shaderProgram_s* sp, bool sendVshCode, bool sendGshCode);

132

133 /**

134 * @brief Same as shaderProgramConfigure, but always loading code/operand descriptors and uploading DVLE constants afterwards.

135 * @param sp Shader program to use.

136 */

137 Result shaderProgramUse(shaderProgram_s* sp);

int8_t s8

8-bit signed integer

Definition: types.h:26

types.h

Various system types.

Result

s32 Result

Function result.

Definition: types.h:42

shaderInstanceInit

Result shaderInstanceInit(shaderInstance_s *si, DVLE_s *dvle)

Initializes a shader instance.

u16

uint16_t u16

16-bit unsigned integer

Definition: types.h:22

shaderInstance_s::dvle

DVLE_s * dvle

Shader DVLE.

Definition: shaderProgram.h:20

GSH_NORMAL

Normal operation.

Definition: shaderProgram.h:42

float24Uniform_s::id

u32 id

Uniform ID.

Definition: shaderProgram.h:13

shaderProgram_s::geoShaderInputStride

u8 geoShaderInputStride

Geometry shader input stride.

Definition: shaderProgram.h:35

shaderInstance_s::float24Uniforms

float24Uniform_s * float24Uniforms

24-bit float uniforms.

Definition: shaderProgram.h:24

shaderProgramSetGshInputPermutation

Result shaderProgramSetGshInputPermutation(shaderProgram_s *sp, u64 permutation)

Configures the permutation of the input attributes of the geometry shader of a shader program...

shaderProgram_s::vertexShader

shaderInstance_s * vertexShader

Vertex shader.

Definition: shaderProgram.h:32

shaderProgram_s

Describes an instance of a full shader program.

Definition: shaderProgram.h:30

shaderProgramSetGshMode

Result shaderProgramSetGshMode(shaderProgram_s *sp, geoShaderMode mode)

Configures the operation mode of the geometry shader of a shader program.

shaderInstance_s::numFloat24Uniforms

u8 numFloat24Uniforms

Float uniform count.

Definition: shaderProgram.h:26

shaderInstanceSetBool

Result shaderInstanceSetBool(shaderInstance_s *si, int id, bool value)

Sets a bool uniform of a shader.

shaderInstance_s::boolUniforms

u16 boolUniforms

Boolean uniforms.

Definition: shaderProgram.h:21

float24Uniform_s

24-bit float uniforms.

Definition: shaderProgram.h:11

GSH_SUBDIVISION_CATMULL_CLARK

Catmull-Clark subdivision surface.

Definition: shaderProgram.h:45

shaderProgram_s::geoShaderMode

u8 geoShaderMode

Geometry shader operation mode.

Definition: shaderProgram.h:36

shaderInstanceGetBool

Result shaderInstanceGetBool(shaderInstance_s *si, int id, bool *value)

Gets a bool uniform of a shader.

shaderInstance_s::intUniformMask

u8 intUniformMask

Used integer uniform mask.

Definition: shaderProgram.h:25

GSH_SUBDIVISION_LOOP

Loop subdivision surface.

Definition: shaderProgram.h:44

DVLE_s

DVLE data.

Definition: shbin.h:65

geoShaderMode

Geometry shader operation modes.

Definition: shaderProgram.h:40

GSH_PARTICLE

Particle system.

Definition: shaderProgram.h:43

shaderInstance_s::boolUniformMask

u16 boolUniformMask

Used boolean uniform mask.

Definition: shaderProgram.h:22

geoShaderInputStride

geoShaderMode

Detailed Description

Describes an instance of a full shader program.