Classes | Public Member Functions
HardwareSurface Class Reference

## Detailed Description

HardwareSurface class used for encapsulating a 2D shader texture surface.

Since:
  9.0 (2011)

`#include <xsi_hardwaresurface.h>`

Inheritance diagram for HardwareSurface:
[legend]

List of all members.

## Classes
class | Options
| This class represents the options used for creating HardwareSurface objects. More...
## Public Member Functions
| HardwareSurface ()
| ~HardwareSurface ()
| HardwareSurface (const CRef &in_ref)
| HardwareSurface (const HardwareSurface &in_obj)
bool | IsA (siClassID in_ClassID) const
siClassID | GetClassID () const
HardwareSurface & | operator= (const HardwareSurface &in_obj)
HardwareSurface & | operator= (const CRef &in_ref)
void * | GetInterface ()

## Constructor & Destructor Documentation

HardwareSurface | ( |  | ) |

Default constructor.

~HardwareSurface | ( |  | ) |

Default destructor.

HardwareSurface | ( | const CRef & | in_ref | ) |

Constructor.

Parameters:

  in_ref | constant reference object.

HardwareSurface | ( | const HardwareSurface & | in_obj | ) |

Copy constructor.

Parameters:

  in_obj | constant class object.

## Member Function Documentation

bool IsA | ( | siClassID | in_ClassID | ) | const`[virtual]`

Returns true if a given class type is compatible with this API class.

Parameters:

  in_ClassID | class type.

Returns:
  true if the class is compatible, false otherwise.

Reimplemented from SIObject.

siClassID GetClassID | ( |  | ) | const`[virtual]`

Returns the type of the API class.

Returns:
  The class type.

Reimplemented from SIObject.

HardwareSurface& operator= | ( | const HardwareSurface & | in_obj | ) |

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

  in_obj | constant class object.

Returns:
  The new HardwareSurface object.

HardwareSurface& operator= | ( | const CRef & | in_ref | ) |

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

  in_ref | constant class object.

Returns:
  The new HardwareSurface object.

Reimplemented from SIObject.

void* GetInterface | ( |  | ) |

Returns a void* which represents the interface to the Graphics API. For OpenGL, the returned pointer should be casted to a GLuint which represents the texture object. For DirectX9, it should be casted to a IDirectX9Texture.

Returns:
  Graphic API interface pointer.

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

- xsi_hardwaresurface.h