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

A class that specifies the boolean flags for transfering data to/from a graphics context. More...

#include <omGraphicsTransferFlags.h>

Public Types

enum  Flag {
  NONE = 0, BUFFERS = (1 << 0), TEXTURES = (1 << 1), PROGRAMS = (1 << 2),
  FRAMEBUFFERS = (1 << 3), ALL = (-1)
}
 An enum that specifies the different transfer flags. More...
 

Public Member Functions

 TransferFlags ()
 Create a new transfer flags object with no flags set. More...
 
 TransferFlags (Flag flag)
 Create a new transfer flags object with the specified flag value initially set. More...
 
 TransferFlags (UInt32 newFlags)
 Create a new transfer flags object with the specified initial combined flags value. More...
 
 operator UInt32 () const
 Convert this transfer flags object to an integer value. More...
 
Bool isSet (Flag flag) const
 Return whether or not the specified flag value is set for this flags object. More...
 
void set (Flag flag, Bool newIsSet)
 Set whether or not the specified flag value is set for this flags object. More...
 

Detailed Description

A class that specifies the boolean flags for transfering data to/from a graphics context.

Member Enumeration Documentation

An enum that specifies the different transfer flags.

Enumerator
NONE 

The flag value when no flags are set.

BUFFERS 

A transfer flag indicating that buffers should be uploaded to the context.

TEXTURES 

A transfer flag indicating that textures should be uploaded to the context.

PROGRAMS 

A transfer flag indicating that shader programs should be uploaded to the context.

FRAMEBUFFERS 

A transfer flag indicating that framebuffer objects should be uploaded to the context.

ALL 

A transfer flag indicating that all context objects should be uploaded.

Constructor & Destructor Documentation

om::graphics::devices::TransferFlags::TransferFlags ( )
inline

Create a new transfer flags object with no flags set.

om::graphics::devices::TransferFlags::TransferFlags ( Flag  flag)
inline

Create a new transfer flags object with the specified flag value initially set.

om::graphics::devices::TransferFlags::TransferFlags ( UInt32  newFlags)
inline

Create a new transfer flags object with the specified initial combined flags value.

Member Function Documentation

om::graphics::devices::TransferFlags::operator UInt32 ( ) const
inline

Convert this transfer flags object to an integer value.

This operator is provided so that the object can be used as an integer value for bitwise logical operations.

Bool om::graphics::devices::TransferFlags::isSet ( Flag  flag) const
inline

Return whether or not the specified flag value is set for this flags object.

void om::graphics::devices::TransferFlags::set ( Flag  flag,
Bool  newIsSet 
)
inline

Set whether or not the specified flag value is set for this flags object.


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