MSDN Documentation > Windows > DirectX > API Reference

DirectX API Reference

Introduction to DirectX APIs

DirectX is a collection of APIs for handling tasks related to multimedia, especially game programming and video, on Microsoft platforms. It includes APIs for 2D and 3D graphics rendering, audio, input, and networking. This documentation provides a comprehensive guide to the various DirectX APIs, their functionalities, and how to use them effectively in your applications.

The DirectX family has evolved significantly over the years, with newer versions offering improved performance, flexibility, and modern feature sets. Understanding the core components and their interdependencies is crucial for developing high-performance graphics and multimedia applications on Windows.

Core DirectX APIs

Direct3D (D3D)

Direct3D is the primary API for rendering 3D graphics. It's responsible for drawing complex scenes with textures, lighting, and effects. Modern versions like Direct3D 11 and Direct3D 12 offer advanced features and hardware acceleration.

Key Concepts:

  • Device and Swap Chain: The fundamental objects for interacting with the graphics hardware.
  • Resources: Textures, buffers (vertex, index, constant), and render targets.
  • Pipelines: The sequence of stages involved in rendering a frame.
  • Shaders: Programs that run on the GPU to process vertices and pixels.

Common Functions:

D3D11CreateDevice(...)
ID3D11Device::CreateBuffer(...)
ID3D11DeviceContext::IASetPrimitiveTopology(...)
ID3D11DeviceContext::Draw(...)

Direct2D

Direct2D is a hardware-accelerated, two-dimensional vector graphics API that provides high performance for 2D rendering. It's ideal for user interface elements, 2D games, and rich graphical content.

Key Concepts:

  • Device and Context: Similar to Direct3D, for interacting with the GPU for 2D.
  • Geometries: Shapes like lines, rectangles, ellipses, and paths.
  • Bitmaps and Brushes: For filling shapes and drawing images.
  • Text Rendering: Integrated support for high-quality text.

Common Functions:

D2D1CreateFactory(...)
ID2D1DeviceContext::DrawGeometry(...)
ID2D1RenderTarget::DrawBitmap(...)
ID2D1RenderTarget::DrawText(...)

DirectWrite

DirectWrite is a text API that provides high-quality text rendering, cross-application font interoperability, and full Unicode support. It works seamlessly with Direct2D for rendering text.

Key Concepts:

  • Text Format: Specifies font, size, and style.
  • Text Layout: Handles text wrapping, alignment, and glyph positioning.
  • GDI Compatibility: Offers options for compatibility with GDI text rendering.

Common Functions:

DWriteCreateFactory(...)
IDWriteTextFormat::SetTextAlignment(...)
IDWriteTextLayout::SetMaxWidth(...)
IDWriteTextLayout::Draw(...)

DirectInput

DirectInput is an older API for handling input devices such as keyboards, mice, joysticks, and gamepads. While still functional, modern games often prefer XInput for gamepad support due to its standardized interface and rumble support.

Key Concepts:

  • Device Enumeration: Discovering available input devices.
  • Device Acquisition: Gaining access to a specific device.
  • Data Acquisition: Reading input states and values.

Common Functions:

DirectInput8Create(...)
IDirectInputDevice8::Acquire(...)
IDirectInputDevice8::GetDeviceState(...)

DirectSound & XAudio2

DirectSound is an older API for audio playback. XAudio2 is the more modern, low-level audio API designed for games, offering features like advanced mixing, effects processing, and support for various audio formats.

Key Concepts (XAudio2):

  • Mastering Voice: The primary audio output.
  • Source Voices: For playing audio from buffers.
  • Submix Voices: For applying effects and mixing.
  • Audio Callbacks: For managing audio buffers.

Common Functions (XAudio2):

XAudio2Create(...)
IXAudio2::CreateMasteringVoice(...)
IXAudio2::CreateSourceVoice(...)
IXAudio2SourceVoice::SubmitSourceBuffer(...)

Utilities and Helper APIs

DXGI (DirectX Graphics Infrastructure)

DXGI provides the foundation for DirectX graphics APIs. It manages the presentation of graphics to the screen and handles adapter enumeration, output enumeration, and swap chain creation. It bridges the gap between the graphics driver and the DirectX runtime.

Key Components:

  • IDXGIFactory: For enumerating adapters and outputs.
  • IDXGIAdapter: Represents a graphics adapter.
  • IDXGIOutput: Represents a monitor output.
  • IDXGISwapChain: Manages the presentation of rendered frames.

Common Functions:

CreateDXGIFactory1(...)
IDXGIFactory::EnumAdapters(...)
IDXGISwapChain::Present(...)

D3DCompile

The D3DCompile API is used to compile High-Level Shading Language (HLSL) shaders into bytecode that can be executed by the GPU. It also provides functionality for parsing and disassembling shader code.

Key Function:

D3DCompileFromFile(...)
D3DDisassemble(...)

Specific Topics & Best Practices

Shaders

Shaders are small programs that run on the GPU and define how objects are rendered. They are written in languages like HLSL. Key shader types include:

  • Vertex Shader: Processes individual vertices.
  • Pixel (Fragment) Shader: Processes individual pixels.
  • Geometry Shader: Generates or modifies primitives.
  • Compute Shader: For general-purpose computation on the GPU.

Resource Management

Efficiently managing graphics resources like textures and buffers is critical for performance. This includes proper creation, binding, and release of these resources to avoid memory leaks and ensure optimal GPU utilization.

Performance Tuning

Achieving high frame rates requires careful optimization. Techniques include:

  • Minimizing draw calls.
  • Batching geometry.
  • Optimizing shader complexity.
  • Utilizing GPU profiling tools.
  • Choosing appropriate API features (e.g., Direct3D 12 for modern applications).

Detailed API Reference

For in-depth details on specific functions, structures, enumerations, and interfaces, please refer to the official Microsoft DirectX documentation. This section typically links to detailed pages for each API component.

You can find detailed API documentation by navigating through the sidebar or by using the search functionality. Each function, interface, and structure has its own dedicated page with explanations, parameter descriptions, return values, and code examples.

Example: Direct3D 11 Device Creation