MagGetFullscreenTransform function (magnification.h)

Article
02/22/2024

Retrieves the magnification settings for the full-screen magnifier.

Syntax

BOOL MagGetFullscreenTransform(
  [out] float *pMagLevel,
  [out] int   *pxOffset,
  [out] int   *pyOffset
);

Parameters

[out] pMagLevel

Type: float*

The current magnification factor for the full-screen magnifier. A value of 1.0 indicates that the screen content is not being magnified. A value above 1.0 indicates the scale factor for magnification. A value less than 1.0 is not valid.

[out] pxOffset

Type: int*

The x-coordinate offset for the upper-left corner of the unmagnified view. The offset is relative to the upper-left corner of the primary monitor, in unmagnified coordinates.

[out] pyOffset

Type: int*

The y-coordinate offset for the upper-left corner of the unmagnified view. The offset is relative to the upper-left corner of the primary monitor, in unmagnified coordinates.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

The offsets are not affected by the current dots per inch (dpi) setting.

Examples

The following code snippet retrieves the magnification value and offsets for the full-screen magnifier.

    // Get the current magnification level and offset.
    float  magLevel;
    int    xOffset, yOffset;

    if (!MagGetFullscreenTransform(&magLevel, &xOffset, &yOffset))
    {
        return E_FAIL;
    }
    
    // 
    // Do something with the magnification settings.
    //

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	magnification.h
Library	Magnification.lib
DLL	Magnification.dll

Share via