Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | List of all members
om::graphics::devices::UploadRequest Class Reference

A class specifies additional parameters for uploading data to a graphics context. More...

#include <omGraphicsUploadRequest.h>

Public Member Functions

 UploadRequest ()
 Create a new upload request with the default state. More...
 

Public Attributes

Index uploadID
 The ID of this update request that uniquely identifies it. More...
 
TransferFlags flags
 A collection of flags for the request that specifiy what data should be transfered. More...
 
GraphicsContextCapabilities capabilities
 The capabilities of the current context that should be used when determining what data to upload. More...
 
const materials::ShaderConfigurationconfiguration
 A pointer to an external shader configuration that contains external parameters for shader compilation. More...
 
const materials::ConstantSetconstants
 A pointer to an external constant set that should be used to provide constant data for material techniques. More...
 
const textures::TextureSettextures
 A pointer to an external texture set that should be used to provide texture data for material techniques. More...
 
const base::RenderModerenderMode
 A pointer to an external render mode that should be used to modify material technique render modes. More...
 
base::RenderModeMask renderModeMask
 A mask indicating the render mode parameters that should be updated during the request. More...
 

Detailed Description

A class specifies additional parameters for uploading data to a graphics context.

Constructor & Destructor Documentation

om::graphics::devices::UploadRequest::UploadRequest ( )
inline

Create a new upload request with the default state.

Member Data Documentation

Index om::graphics::devices::UploadRequest::uploadID

The ID of this update request that uniquely identifies it.

The ID keeps shared objects from uploading their data more than once on the same request. Each time that data should be uploaded the upload ID should be incremented by the user.

TransferFlags om::graphics::devices::UploadRequest::flags

A collection of flags for the request that specifiy what data should be transfered.

GraphicsContextCapabilities om::graphics::devices::UploadRequest::capabilities

The capabilities of the current context that should be used when determining what data to upload.

const materials::ShaderConfiguration* om::graphics::devices::UploadRequest::configuration

A pointer to an external shader configuration that contains external parameters for shader compilation.

const materials::ConstantSet* om::graphics::devices::UploadRequest::constants

A pointer to an external constant set that should be used to provide constant data for material techniques.

const textures::TextureSet* om::graphics::devices::UploadRequest::textures

A pointer to an external texture set that should be used to provide texture data for material techniques.

const base::RenderMode* om::graphics::devices::UploadRequest::renderMode

A pointer to an external render mode that should be used to modify material technique render modes.

base::RenderModeMask om::graphics::devices::UploadRequest::renderModeMask

A mask indicating the render mode parameters that should be updated during the request.


The documentation for this class was generated from the following file: