2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 * -# 4x4 transformation matrices are stored in memory in column major order.
33 * -# Points/vertices are to be thought of as column vectors.
34 * -# Transformation of a point p by a matrix M is: p' = M * p
43 #include "mfeatures.h"
46 #include "math/m_matrix.h"
50 * Apply a perspective projection matrix.
52 * \param left left clipping plane coordinate.
53 * \param right right clipping plane coordinate.
54 * \param bottom bottom clipping plane coordinate.
55 * \param top top clipping plane coordinate.
56 * \param nearval distance to the near clipping plane.
57 * \param farval distance to the far clipping plane.
61 * Flushes vertices and validates parameters. Calls _math_matrix_frustum() with
62 * the top matrix of the current matrix stack and sets
63 * __struct gl_contextRec::NewState.
66 _mesa_Frustum( GLdouble left
, GLdouble right
,
67 GLdouble bottom
, GLdouble top
,
68 GLdouble nearval
, GLdouble farval
)
70 GET_CURRENT_CONTEXT(ctx
);
71 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
79 _mesa_error( ctx
, GL_INVALID_VALUE
, "glFrustum" );
83 _math_matrix_frustum( ctx
->CurrentStack
->Top
,
84 (GLfloat
) left
, (GLfloat
) right
,
85 (GLfloat
) bottom
, (GLfloat
) top
,
86 (GLfloat
) nearval
, (GLfloat
) farval
);
87 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
92 * Apply an orthographic projection matrix.
94 * \param left left clipping plane coordinate.
95 * \param right right clipping plane coordinate.
96 * \param bottom bottom clipping plane coordinate.
97 * \param top top clipping plane coordinate.
98 * \param nearval distance to the near clipping plane.
99 * \param farval distance to the far clipping plane.
103 * Flushes vertices and validates parameters. Calls _math_matrix_ortho() with
104 * the top matrix of the current matrix stack and sets
105 * __struct gl_contextRec::NewState.
108 _mesa_Ortho( GLdouble left
, GLdouble right
,
109 GLdouble bottom
, GLdouble top
,
110 GLdouble nearval
, GLdouble farval
)
112 GET_CURRENT_CONTEXT(ctx
);
113 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
115 if (MESA_VERBOSE
& VERBOSE_API
)
116 _mesa_debug(ctx
, "glOrtho(%f, %f, %f, %f, %f, %f)\n",
117 left
, right
, bottom
, top
, nearval
, farval
);
123 _mesa_error( ctx
, GL_INVALID_VALUE
, "glOrtho" );
127 _math_matrix_ortho( ctx
->CurrentStack
->Top
,
128 (GLfloat
) left
, (GLfloat
) right
,
129 (GLfloat
) bottom
, (GLfloat
) top
,
130 (GLfloat
) nearval
, (GLfloat
) farval
);
131 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
136 * Set the current matrix stack.
138 * \param mode matrix stack.
140 * \sa glMatrixMode().
142 * Flushes the vertices, validates the parameter and updates
143 * __struct gl_contextRec::CurrentStack and gl_transform_attrib::MatrixMode
144 * with the specified matrix stack.
147 _mesa_MatrixMode( GLenum mode
)
149 GET_CURRENT_CONTEXT(ctx
);
150 ASSERT_OUTSIDE_BEGIN_END(ctx
);
152 if (ctx
->Transform
.MatrixMode
== mode
&& mode
!= GL_TEXTURE
)
154 FLUSH_VERTICES(ctx
, _NEW_TRANSFORM
);
158 ctx
->CurrentStack
= &ctx
->ModelviewMatrixStack
;
161 ctx
->CurrentStack
= &ctx
->ProjectionMatrixStack
;
164 /* This error check is disabled because if we're called from
165 * glPopAttrib() when the active texture unit is >= MaxTextureCoordUnits
166 * we'll generate an unexpected error.
167 * From the GL_ARB_vertex_shader spec it sounds like we should instead
168 * do error checking in other places when we actually try to access
169 * texture matrices beyond MaxTextureCoordUnits.
172 if (ctx
->Texture
.CurrentUnit
>= ctx
->Const
.MaxTextureCoordUnits
) {
173 _mesa_error(ctx
, GL_INVALID_OPERATION
,
174 "glMatrixMode(invalid tex unit %d)",
175 ctx
->Texture
.CurrentUnit
);
179 ASSERT(ctx
->Texture
.CurrentUnit
< Elements(ctx
->TextureMatrixStack
));
180 ctx
->CurrentStack
= &ctx
->TextureMatrixStack
[ctx
->Texture
.CurrentUnit
];
190 if (ctx
->API
== API_OPENGL
191 && (ctx
->Extensions
.ARB_vertex_program
||
192 ctx
->Extensions
.ARB_fragment_program
)) {
193 const GLuint m
= mode
- GL_MATRIX0_ARB
;
194 if (m
> ctx
->Const
.MaxProgramMatrices
) {
195 _mesa_error(ctx
, GL_INVALID_ENUM
,
196 "glMatrixMode(GL_MATRIX%d_ARB)", m
);
199 ctx
->CurrentStack
= &ctx
->ProgramMatrixStack
[m
];
202 _mesa_error( ctx
, GL_INVALID_ENUM
, "glMatrixMode(mode)" );
207 _mesa_error( ctx
, GL_INVALID_ENUM
, "glMatrixMode(mode)" );
211 ctx
->Transform
.MatrixMode
= mode
;
216 * Push the current matrix stack.
218 * \sa glPushMatrix().
220 * Verifies the current matrix stack is not full, and duplicates the top-most
221 * matrix in the stack.
222 * Marks __struct gl_contextRec::NewState with the stack dirty flag.
225 _mesa_PushMatrix( void )
227 GET_CURRENT_CONTEXT(ctx
);
228 struct gl_matrix_stack
*stack
= ctx
->CurrentStack
;
229 ASSERT_OUTSIDE_BEGIN_END(ctx
);
231 if (MESA_VERBOSE
&VERBOSE_API
)
232 _mesa_debug(ctx
, "glPushMatrix %s\n",
233 _mesa_lookup_enum_by_nr(ctx
->Transform
.MatrixMode
));
235 if (stack
->Depth
+ 1 >= stack
->MaxDepth
) {
236 if (ctx
->Transform
.MatrixMode
== GL_TEXTURE
) {
237 _mesa_error(ctx
, GL_STACK_OVERFLOW
,
238 "glPushMatrix(mode=GL_TEXTURE, unit=%d)",
239 ctx
->Texture
.CurrentUnit
);
242 _mesa_error(ctx
, GL_STACK_OVERFLOW
, "glPushMatrix(mode=%s)",
243 _mesa_lookup_enum_by_nr(ctx
->Transform
.MatrixMode
));
247 _math_matrix_copy( &stack
->Stack
[stack
->Depth
+ 1],
248 &stack
->Stack
[stack
->Depth
] );
250 stack
->Top
= &(stack
->Stack
[stack
->Depth
]);
251 ctx
->NewState
|= stack
->DirtyFlag
;
256 * Pop the current matrix stack.
260 * Flushes the vertices, verifies the current matrix stack is not empty, and
261 * moves the stack head down.
262 * Marks __struct gl_contextRec::NewState with the dirty stack flag.
265 _mesa_PopMatrix( void )
267 GET_CURRENT_CONTEXT(ctx
);
268 struct gl_matrix_stack
*stack
= ctx
->CurrentStack
;
269 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
271 if (MESA_VERBOSE
&VERBOSE_API
)
272 _mesa_debug(ctx
, "glPopMatrix %s\n",
273 _mesa_lookup_enum_by_nr(ctx
->Transform
.MatrixMode
));
275 if (stack
->Depth
== 0) {
276 if (ctx
->Transform
.MatrixMode
== GL_TEXTURE
) {
277 _mesa_error(ctx
, GL_STACK_UNDERFLOW
,
278 "glPopMatrix(mode=GL_TEXTURE, unit=%d)",
279 ctx
->Texture
.CurrentUnit
);
282 _mesa_error(ctx
, GL_STACK_UNDERFLOW
, "glPopMatrix(mode=%s)",
283 _mesa_lookup_enum_by_nr(ctx
->Transform
.MatrixMode
));
288 stack
->Top
= &(stack
->Stack
[stack
->Depth
]);
289 ctx
->NewState
|= stack
->DirtyFlag
;
294 * Replace the current matrix with the identity matrix.
296 * \sa glLoadIdentity().
298 * Flushes the vertices and calls _math_matrix_set_identity() with the
299 * top-most matrix in the current stack.
300 * Marks __struct gl_contextRec::NewState with the stack dirty flag.
303 _mesa_LoadIdentity( void )
305 GET_CURRENT_CONTEXT(ctx
);
306 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
308 if (MESA_VERBOSE
& VERBOSE_API
)
309 _mesa_debug(ctx
, "glLoadIdentity()\n");
311 _math_matrix_set_identity( ctx
->CurrentStack
->Top
);
312 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
317 * Replace the current matrix with a given matrix.
321 * \sa glLoadMatrixf().
323 * Flushes the vertices and calls _math_matrix_loadf() with the top-most
324 * matrix in the current stack and the given matrix.
325 * Marks __struct gl_contextRec::NewState with the dirty stack flag.
328 _mesa_LoadMatrixf( const GLfloat
*m
)
330 GET_CURRENT_CONTEXT(ctx
);
332 if (MESA_VERBOSE
& VERBOSE_API
)
334 "glLoadMatrix(%f %f %f %f, %f %f %f %f, %f %f %f %f, %f %f %f %f\n",
335 m
[0], m
[4], m
[8], m
[12],
336 m
[1], m
[5], m
[9], m
[13],
337 m
[2], m
[6], m
[10], m
[14],
338 m
[3], m
[7], m
[11], m
[15]);
340 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
341 _math_matrix_loadf( ctx
->CurrentStack
->Top
, m
);
342 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
347 * Multiply the current matrix with a given matrix.
351 * \sa glMultMatrixf().
353 * Flushes the vertices and calls _math_matrix_mul_floats() with the top-most
354 * matrix in the current stack and the given matrix. Marks
355 * __struct gl_contextRec::NewState with the dirty stack flag.
358 _mesa_MultMatrixf( const GLfloat
*m
)
360 GET_CURRENT_CONTEXT(ctx
);
362 if (MESA_VERBOSE
& VERBOSE_API
)
364 "glMultMatrix(%f %f %f %f, %f %f %f %f, %f %f %f %f, %f %f %f %f\n",
365 m
[0], m
[4], m
[8], m
[12],
366 m
[1], m
[5], m
[9], m
[13],
367 m
[2], m
[6], m
[10], m
[14],
368 m
[3], m
[7], m
[11], m
[15]);
369 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
370 _math_matrix_mul_floats( ctx
->CurrentStack
->Top
, m
);
371 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
376 * Multiply the current matrix with a rotation matrix.
378 * \param angle angle of rotation, in degrees.
379 * \param x rotation vector x coordinate.
380 * \param y rotation vector y coordinate.
381 * \param z rotation vector z coordinate.
385 * Flushes the vertices and calls _math_matrix_rotate() with the top-most
386 * matrix in the current stack and the given parameters. Marks
387 * __struct gl_contextRec::NewState with the dirty stack flag.
390 _mesa_Rotatef( GLfloat angle
, GLfloat x
, GLfloat y
, GLfloat z
)
392 GET_CURRENT_CONTEXT(ctx
);
393 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
395 _math_matrix_rotate( ctx
->CurrentStack
->Top
, angle
, x
, y
, z
);
396 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
402 * Multiply the current matrix with a general scaling matrix.
404 * \param x x axis scale factor.
405 * \param y y axis scale factor.
406 * \param z z axis scale factor.
410 * Flushes the vertices and calls _math_matrix_scale() with the top-most
411 * matrix in the current stack and the given parameters. Marks
412 * __struct gl_contextRec::NewState with the dirty stack flag.
415 _mesa_Scalef( GLfloat x
, GLfloat y
, GLfloat z
)
417 GET_CURRENT_CONTEXT(ctx
);
418 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
419 _math_matrix_scale( ctx
->CurrentStack
->Top
, x
, y
, z
);
420 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
425 * Multiply the current matrix with a translation matrix.
427 * \param x translation vector x coordinate.
428 * \param y translation vector y coordinate.
429 * \param z translation vector z coordinate.
431 * \sa glTranslatef().
433 * Flushes the vertices and calls _math_matrix_translate() with the top-most
434 * matrix in the current stack and the given parameters. Marks
435 * __struct gl_contextRec::NewState with the dirty stack flag.
438 _mesa_Translatef( GLfloat x
, GLfloat y
, GLfloat z
)
440 GET_CURRENT_CONTEXT(ctx
);
441 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
442 _math_matrix_translate( ctx
->CurrentStack
->Top
, x
, y
, z
);
443 ctx
->NewState
|= ctx
->CurrentStack
->DirtyFlag
;
448 _mesa_LoadMatrixd( const GLdouble
*m
)
453 for (i
= 0; i
< 16; i
++)
454 f
[i
] = (GLfloat
) m
[i
];
455 _mesa_LoadMatrixf(f
);
459 _mesa_MultMatrixd( const GLdouble
*m
)
464 for (i
= 0; i
< 16; i
++)
465 f
[i
] = (GLfloat
) m
[i
];
466 _mesa_MultMatrixf( f
);
471 _mesa_Rotated( GLdouble angle
, GLdouble x
, GLdouble y
, GLdouble z
)
473 _mesa_Rotatef((GLfloat
) angle
, (GLfloat
) x
, (GLfloat
) y
, (GLfloat
) z
);
478 _mesa_Scaled( GLdouble x
, GLdouble y
, GLdouble z
)
480 _mesa_Scalef((GLfloat
) x
, (GLfloat
) y
, (GLfloat
) z
);
485 _mesa_Translated( GLdouble x
, GLdouble y
, GLdouble z
)
487 _mesa_Translatef((GLfloat
) x
, (GLfloat
) y
, (GLfloat
) z
);
492 _mesa_LoadTransposeMatrixfARB( const GLfloat
*m
)
496 _math_transposef(tm
, m
);
497 _mesa_LoadMatrixf(tm
);
502 _mesa_LoadTransposeMatrixdARB( const GLdouble
*m
)
506 _math_transposefd(tm
, m
);
507 _mesa_LoadMatrixf(tm
);
512 _mesa_MultTransposeMatrixfARB( const GLfloat
*m
)
516 _math_transposef(tm
, m
);
517 _mesa_MultMatrixf(tm
);
522 _mesa_MultTransposeMatrixdARB( const GLdouble
*m
)
526 _math_transposefd(tm
, m
);
527 _mesa_MultMatrixf(tm
);
532 /**********************************************************************/
533 /** \name State management */
538 * Update the projection matrix stack.
540 * \param ctx GL context.
542 * Calls _math_matrix_analyse() with the top-matrix of the projection matrix
543 * stack, and recomputes user clip positions if necessary.
545 * \note This routine references __struct gl_contextRec::Tranform attribute
546 * values to compute userclip positions in clip space, but is only called on
547 * _NEW_PROJECTION. The _mesa_ClipPlane() function keeps these values up to
548 * date across changes to the __struct gl_contextRec::Transform attributes.
551 update_projection( struct gl_context
*ctx
)
553 _math_matrix_analyse( ctx
->ProjectionMatrixStack
.Top
);
555 /* Recompute clip plane positions in clipspace. This is also done
556 * in _mesa_ClipPlane().
558 if (ctx
->Transform
.ClipPlanesEnabled
) {
560 for (p
= 0; p
< ctx
->Const
.MaxClipPlanes
; p
++) {
561 if (ctx
->Transform
.ClipPlanesEnabled
& (1 << p
)) {
562 _mesa_transform_vector( ctx
->Transform
._ClipUserPlane
[p
],
563 ctx
->Transform
.EyeUserPlane
[p
],
564 ctx
->ProjectionMatrixStack
.Top
->inv
);
572 * Calculate the combined modelview-projection matrix.
574 * \param ctx GL context.
576 * Multiplies the top matrices of the projection and model view stacks into
577 * __struct gl_contextRec::_ModelProjectMatrix via _math_matrix_mul_matrix()
578 * and analyzes the resulting matrix via _math_matrix_analyse().
581 calculate_model_project_matrix( struct gl_context
*ctx
)
583 _math_matrix_mul_matrix( &ctx
->_ModelProjectMatrix
,
584 ctx
->ProjectionMatrixStack
.Top
,
585 ctx
->ModelviewMatrixStack
.Top
);
587 _math_matrix_analyse( &ctx
->_ModelProjectMatrix
);
592 * Updates the combined modelview-projection matrix.
594 * \param ctx GL context.
595 * \param new_state new state bit mask.
597 * If there is a new model view matrix then analyzes it. If there is a new
598 * projection matrix, updates it. Finally calls
599 * calculate_model_project_matrix() to recalculate the modelview-projection
602 void _mesa_update_modelview_project( struct gl_context
*ctx
, GLuint new_state
)
604 if (new_state
& _NEW_MODELVIEW
) {
605 _math_matrix_analyse( ctx
->ModelviewMatrixStack
.Top
);
607 /* Bring cull position up to date.
609 TRANSFORM_POINT3( ctx
->Transform
.CullObjPos
,
610 ctx
->ModelviewMatrixStack
.Top
->inv
,
611 ctx
->Transform
.CullEyePos
);
615 if (new_state
& _NEW_PROJECTION
)
616 update_projection( ctx
);
618 /* Keep ModelviewProject up to date always to allow tnl
619 * implementations that go model->clip even when eye is required.
621 calculate_model_project_matrix(ctx
);
627 /**********************************************************************/
628 /** Matrix stack initialization */
633 * Initialize a matrix stack.
635 * \param stack matrix stack.
636 * \param maxDepth maximum stack depth.
637 * \param dirtyFlag dirty flag.
639 * Allocates an array of \p maxDepth elements for the matrix stack and calls
640 * _math_matrix_ctr() for each element to initialize it.
643 init_matrix_stack( struct gl_matrix_stack
*stack
,
644 GLuint maxDepth
, GLuint dirtyFlag
)
649 stack
->MaxDepth
= maxDepth
;
650 stack
->DirtyFlag
= dirtyFlag
;
652 stack
->Stack
= calloc(maxDepth
, sizeof(GLmatrix
));
653 for (i
= 0; i
< maxDepth
; i
++) {
654 _math_matrix_ctr(&stack
->Stack
[i
]);
656 stack
->Top
= stack
->Stack
;
662 * \param stack matrix stack.
664 * Calls _math_matrix_dtr() for each element of the matrix stack and
668 free_matrix_stack( struct gl_matrix_stack
*stack
)
671 for (i
= 0; i
< stack
->MaxDepth
; i
++) {
672 _math_matrix_dtr(&stack
->Stack
[i
]);
675 stack
->Stack
= stack
->Top
= NULL
;
681 /**********************************************************************/
682 /** \name Initialization */
687 * Initialize the context matrix data.
689 * \param ctx GL context.
691 * Initializes each of the matrix stacks and the combined modelview-projection
694 void _mesa_init_matrix( struct gl_context
* ctx
)
698 /* Initialize matrix stacks */
699 init_matrix_stack(&ctx
->ModelviewMatrixStack
, MAX_MODELVIEW_STACK_DEPTH
,
701 init_matrix_stack(&ctx
->ProjectionMatrixStack
, MAX_PROJECTION_STACK_DEPTH
,
703 for (i
= 0; i
< Elements(ctx
->TextureMatrixStack
); i
++)
704 init_matrix_stack(&ctx
->TextureMatrixStack
[i
], MAX_TEXTURE_STACK_DEPTH
,
705 _NEW_TEXTURE_MATRIX
);
706 for (i
= 0; i
< Elements(ctx
->ProgramMatrixStack
); i
++)
707 init_matrix_stack(&ctx
->ProgramMatrixStack
[i
],
708 MAX_PROGRAM_MATRIX_STACK_DEPTH
, _NEW_TRACK_MATRIX
);
709 ctx
->CurrentStack
= &ctx
->ModelviewMatrixStack
;
711 /* Init combined Modelview*Projection matrix */
712 _math_matrix_ctr( &ctx
->_ModelProjectMatrix
);
717 * Free the context matrix data.
719 * \param ctx GL context.
721 * Frees each of the matrix stacks and the combined modelview-projection
724 void _mesa_free_matrix_data( struct gl_context
*ctx
)
728 free_matrix_stack(&ctx
->ModelviewMatrixStack
);
729 free_matrix_stack(&ctx
->ProjectionMatrixStack
);
730 for (i
= 0; i
< Elements(ctx
->TextureMatrixStack
); i
++)
731 free_matrix_stack(&ctx
->TextureMatrixStack
[i
]);
732 for (i
= 0; i
< Elements(ctx
->ProgramMatrixStack
); i
++)
733 free_matrix_stack(&ctx
->ProgramMatrixStack
[i
]);
734 /* combined Modelview*Projection matrix */
735 _math_matrix_dtr( &ctx
->_ModelProjectMatrix
);
741 * Initialize the context transform attribute group.
743 * \param ctx GL context.
745 * \todo Move this to a new file with other 'transform' routines.
747 void _mesa_init_transform( struct gl_context
*ctx
)
751 /* Transformation group */
752 ctx
->Transform
.MatrixMode
= GL_MODELVIEW
;
753 ctx
->Transform
.Normalize
= GL_FALSE
;
754 ctx
->Transform
.RescaleNormals
= GL_FALSE
;
755 ctx
->Transform
.RasterPositionUnclipped
= GL_FALSE
;
756 for (i
=0;i
<ctx
->Const
.MaxClipPlanes
;i
++) {
757 ASSIGN_4V( ctx
->Transform
.EyeUserPlane
[i
], 0.0, 0.0, 0.0, 0.0 );
759 ctx
->Transform
.ClipPlanesEnabled
= 0;
761 ASSIGN_4V( ctx
->Transform
.CullObjPos
, 0.0, 0.0, 1.0, 0.0 );
762 ASSIGN_4V( ctx
->Transform
.CullEyePos
, 0.0, 0.0, 1.0, 0.0 );