API Documentation

The Veldrid API documentation is automatically generated from source-code-level comments. Often, more information can be found by looking into the source code itself.

See API Concepts for a broad overview and description of the most common Veldrid object types. Also, take a look at the Samples repository for a more hands-on demonstration of Veldrid.

• GraphicsDevice: An abstract graphics device. This is the central object in Veldrid. All other resources are created and owned by a GraphicsDevice; as such, it is the first object you will create when dealing with Veldrid.
• CommandList: A device resource which enables the recording of graphics and compute commands. Later, they can be submitted to the GraphicsDevice for execution.
• DeviceBuffer and Texture: Device resources capable of storing various types of structured data, which can be read by the GPU.
• Pipeline and ResourceSet: Two important kinds of device resources which set up the GPU state necessary for issuing draw and compute commands.
• Framebuffer: A resource which controls where draw commands are rendered to.