GetMode

Gets the current VSync mode on a GPU.

Syntax

Copied!

ADLX_RESULT     GetMode (ADLX_WAIT_FOR_VERTICAL_REFRESH_MODE * currentMode)

Parameters

  1. [out] currentMode ADLX_WAIT_FOR_VERTICAL_REFRESH_MODE * The pointer to a variable where the current VSync mode is returned.

Return Value

If the current VSync mode is successfully returned, ADLX_OK is returned.

If the current VSync mode is not successfully returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Additional Info

VSync synchronizes the transition to a new frame of animation with the display update so no tearing is visible between frames.

Limits the frame rate at the display’s refresh rate.

Note : VSync configuration is dependent on the state of AMD Radeon™ Enhanced Sync.

If AMD Radeon Enhanced Sync is enabled, VSync is automatically disabled.

If AMD Radeon Enhanced Sync is disabled, VSync is automatically enabled.

Requirements

Header

include “I3DSettings.h”

Minimum version

1.0

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!