GreGetGlobalViewingXform: Difference between revisions

Latest revision as of 20:23, 17 January 2020

GreGetGlobalViewingXform queries the global viewing transform matrix. On completion, paXformData points to an array of two-dimensional values that defines the global viewing transform matrix.

This function can be hooked by the presentation driver.

Simulation support: This function is simulated by a handling routine in the graphics engine.

Syntax

 GreGetGlobalViewingXform(hdc, paXformData, pInstance, lFunction)

Parameters

hdc (HDC) - input: Device context handle.
paXformData (PXFORM) - input: Pointer to return data; Pointer to return data in which the array of six matrix elements (M11, M12, M21, M22, M41, and M42) are to be stored.
pInstance (PVOID) - input: Pointer to instance data.
lFunction (ULONG) - input: High-order WORD=flags; low-order WORD=NGreGetGlobalViewingXform.

Returns

fSuccess (BOOL) - returns

Return codes.

This function returns BOOLEAN (fSuccess).

TRUE Successful
FALSE Error

Possible Errors Detected

When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:

PMERR_HDC_BUSY
PMERR_INV_HDC

Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

@@ Line 1: / Line 1: @@
 GreGetGlobalViewingXform queries the global viewing transform matrix. On completion, paXformData points to an array of two-dimensional values that defines the global viewing transform matrix.
 This function can be hooked by the presentation driver.
 ;Simulation support: This function is simulated by a handling routine in the graphics engine.
 == Syntax ==
-   GreGetGlobalViewingXform(hdc, paXformData, pInstance, lFunction);
+   GreGetGlobalViewingXform(hdc, paXformData, pInstance, lFunction)
 == Parameters ==
-;hdc (HDC) - input
+;hdc (HDC) - input:Device context handle.
-:Device context handle.
+;paXformData (PXFORM) - input:Pointer to return data
+:Pointer to return data in which the array of six matrix elements (M11, M12, M21, M22, M41, and M42) are to be stored.
-;paXformData (PXFORM) - input
+;pInstance (PVOID) - input:Pointer to instance data.
-:Pointer to return data
+;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetGlobalViewingXform.
-:Pointer to return data in which the array of six matrix elements (M11, M12, M21, M22, M41, and M42) are to be stored.
-;pInstance (PVOID) - input
-:Pointer to instance data.
-;lFunction (ULONG) - input
-:High-order WORD=flags; low-order WORD=NGreGetGlobalViewingXform.
 == Returns ==
-;fSuccess (BOOL) - returns
+;fSuccess (BOOL) - returns:Return codes.
-:Return codes.
+:This function returns BOOLEAN (fSuccess).
+:*TRUE Successful
-:This function returns BOOLEAN (fSuccess).
+:*FALSE Error
-:*TRUE Successful
+;Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
-:*FALSE Error
+:*PMERR_HDC_BUSY
+:*PMERR_INV_HDC
-;Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:
+:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.
-:*PMERR_HDC_BUSY
-:*PMERR_INV_HDC
-:Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.
-== Sample ==
-<pre>
-#define INCL_GRE_XFORMS
-#include <os2.h>
-HDC       hdc;          /*  Device context handle. */
-PXFORM    paXformData;  /*  Pointer to return data */
-PVOID     pInstance;    /*  Pointer to instance data. */
-ULONG     lFunction;    /*  High-order WORD=flags; low-order WORD=NGreGetGlobalViewingXform. */
-BOOL      fSuccess;     /*  Return codes. */
-fSuccess = GreGetGlobalViewingXform(hdc, paXformData,
-             pInstance, lFunction);
-</pre>
 [[Category:Gre]]