DisplayScalingMode

Demonstrates how to obtain the display scaling mode when programming with ADLX and perform related operations.

Command Prompts

Command Prompt Description
1 Display scaling mode support.
2 Get scaling mode state.
3 Set current scaling mode to PRESERVE_ASPECT_RATIO.
4 Set current scaling mode to FULL_PANEL.
5 Set current scaling mode to CENTERED.
M/m Display the command prompt menu.
Q/q Terminate the application.

Sample Path

/Samples/C/Display/DisplayScalingMode

Code

Copied!

//
// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
//
//-------------------------------------------------------------------------------------------------


#include "SDK/ADLXHelper/Windows/C/ADLXHelper.h"
#include "SDK/Include/IDisplaySettings.h"
#include "SDK/Include/IDisplays.h"

// Display displayScalingMode support
void ShowDisplayScalingModeSupport(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay);

// Display current displayScalingMode state
void GetScalingModeState(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay);

// Set displayScalingMode
void SetScalingModeState(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay, const int key);

// Main menu
void MainMenu();

// Menu action control
void MenuControl(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay);

// Wait for exit with error message
int WaitAndExit(const char* msg, const int retCode);

int main()
{
    // Define return code
    ADLX_RESULT  res = ADLX_FAIL ;

    // Initialize ADLX
    res = ADLXHelper_Initialize();
    if (ADLX_SUCCEEDED (res))
    {
        // Get system service
        IADLXSystem* sys = ADLXHelper_GetSystemServices();

        // Get display service
        IADLXDisplayServices* displayService = NULL;
        res = sys->pVtbl->GetDisplaysServices(sys, &displayService);
        if (ADLX_SUCCEEDED (res))
        {
            // Get display list
            IADLXDisplayList* displayList = NULL;
            res = displayService->pVtbl->GetDisplays(displayService, &displayList);
            if (ADLX_SUCCEEDED (res))
            {
                // Inspect for the first display in the list
                adlx_uint it = 0;
                IADLXDisplay* display = NULL;
                res = displayList->pVtbl->At_DisplayList(displayList, it, &display);
                if (ADLX_SUCCEEDED (res))
                {
                    // Display main menu options
                    MainMenu();
                    // Get and execute the choice
                    MenuControl(displayService, display);
                }

                // Release the display interface
                if (NULL != display)
                {
                    display->pVtbl->Release(display);
                    display = NULL;
                }
            }

            // Release the displayList interface
            if (NULL != displayList)
            {
                displayList->pVtbl->Release(displayList);
                displayList = NULL;
            }
        }

        // Release the displayService interface
        if (NULL != displayService)
        {
            displayService->pVtbl->Release(displayService);
            displayService = NULL;
        }
    }
    else
    {
        return WaitAndExit("ADLX initialization failed", 0);
    }

    // Destroy ADLX
    res = ADLXHelper_Terminate();
    printf("Destroy ADLX result: %d\\n", res);

    // Pause to see the print out
    system("pause");

    return 0;
}

void ShowDisplayScalingModeSupport(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay)
{
    IADLXDisplayScalingMode* pDisplayScalingMode = NULL;
    ADLX_RESULT  res = pDisplayService->pVtbl->GetScalingMode(pDisplayService, pDisplay, &pDisplayScalingMode);
    if (ADLX_SUCCEEDED (res))
    {
        printf("  === Get scaling mode supported ===\\n");
        adlx_bool supported = false;
        res = pDisplayScalingMode->pVtbl->IsSupported(pDisplayScalingMode, &supported);
        printf("\\tScaling mode is supported on the display: %s , return code: %d (0 means success)\\n", supported ? "true" : "false", res);
        pDisplayScalingMode->pVtbl->Release(pDisplayScalingMode);
    }
}

void GetScalingModeState(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay)
{
    IADLXDisplayScalingMode* pDisplayScalingMode = NULL;
    ADLX_RESULT  res = pDisplayService->pVtbl->GetScalingMode(pDisplayService, pDisplay, &pDisplayScalingMode);
    if (ADLX_SUCCEEDED (res))
    {
        printf("  === Get scaling-mode mode ===\\n");
        ADLX_SCALE_MODE  sm = PRESERVE_ASPECT_RATIO ;
        res = pDisplayScalingMode->pVtbl->GetMode(pDisplayScalingMode, &sm);
        char* smStr = "Unknown";
        switch (sm)
        {
        case PRESERVE_ASPECT_RATIO :
            smStr = "PRESERVE_ASPECT_RATIO";
            break;
        case FULL_PANEL :
            smStr = "FULL_PANEL";
            break;
        case CENTERED :
            smStr = "CENTERED";
            break;
        }
        printf("\\tThe scaling mode on the display is %s , return code: %d (0 means success)\\n", smStr, res);
        pDisplayScalingMode->pVtbl->Release(pDisplayScalingMode);
    }
}

void SetScalingModeState(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay, const int key)
{
    IADLXDisplayScalingMode* pDisplayScalingMode = NULL;
    ADLX_RESULT  res = pDisplayService->pVtbl->GetScalingMode(pDisplayService, pDisplay, &pDisplayScalingMode);
    if (ADLX_SUCCEEDED (res))
    {
        ADLX_RESULT  res = ADLX_FAIL ;
        switch (key)
        {
            // Set scaling mode to PRESERVE_ASPECT_RATIO
        case 0:
            printf("  === Set scaling mode to PRESERVE_ASPECT_RATIO ===\\n");
            res = pDisplayScalingMode->pVtbl->SetMode(pDisplayScalingMode, PRESERVE_ASPECT_RATIO );
            break;
            // Set scaling mode to FULL_PANEL
        case 1:
            printf("  === Set scaling mode to FULL_PANEL ===\\n");
            res = pDisplayScalingMode->pVtbl->SetMode(pDisplayScalingMode, FULL_PANEL );
            break;
            // set ScalingMode CENTERED
        case 2:
            printf("  === Set scaling mode to CENTERED ===\\n");
            res = pDisplayScalingMode->pVtbl->SetMode(pDisplayScalingMode, CENTERED );
            break;
        default:
            break;
        }
        printf("\\treturn code is: %d (0 means success)\\n", res);
        pDisplayScalingMode->pVtbl->Release(pDisplayScalingMode);
    }
}

void MainMenu()
{
    printf("\\tChoose from the following options:\\n");

    printf("\\t->Press 1 to Display scaling mode support\\n");

    printf("\\t->Press 2 to get scaling mode state\\n");

    printf("\\t->Press 3 to set current scaling mode to PRESERVE_ASPECT_RATIO\\n");
    printf("\\t->Press 4 to set current scaling mode to FULL_PANEL\\n");
    printf("\\t->Press 5 to set current scaling mode to CENTERED\\n");

    printf("\\t->Press Q/q to terminate the application\\n");
    printf("\\t->Press M/m to display the main menu options\\n");
}

// Menu action control
void MenuControl(IADLXDisplayServices* pDisplayService, IADLXDisplay* pDisplay)
{
    int num = 0;
    while ((num = getchar()) != 'q' && num != 'Q')
    {
        switch (num)
        {
            // Display displayScalingMode support
        case '1':
            ShowDisplayScalingModeSupport(pDisplayService, pDisplay);
            break;

            // Display current displayScalingMode state
        case '2':
            GetScalingModeState(pDisplayService, pDisplay);
            break;

            // Set displayScalingMode
        case '3':
        case '4':
        case '5':
            SetScalingModeState(pDisplayService, pDisplay, num - '3');
            break;

            // Display main menu options
        case 'm':
        case 'M':
            MainMenu();
            break;
        default:
            break;
        }
    }
}

// Wait for exit with error message
int WaitAndExit(const char* msg, const int retCode)
{
    // Printout the message and pause to see it before returning the desired code
    if (NULL != msg)
        printf("%s\\n", msg);

    system("pause");
    return retCode;
}

Related pages

  • Visit the Adlx product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNA™ 2 GPUs, AMD Ryzen™ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!