The IVideo resource object interface. More...

#include "murl_resource_i_video.h"

Inheritance diagram for Murl::Resource::IVideo:

Classes

struct  Iff
 IFF file specific structs. More...
 

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
 
virtual UInt32 GetNumberOfStreams () const =0
 Get the number of individual video streams. More...
 
virtual IVideoStreamCreateStream (UInt32 streamIndex, IEnums::MipMapGenerationMode mipMapGen) const =0
 Create an IVideoStream object from the resource, with default pixel format and size. More...
 
virtual IVideoStreamCreateStream (UInt32 streamIndex, IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, UInt32 divisor, IEnums::MipMapGenerationMode mipMapGen) const =0
 Create an IVideoStream object from the resource, with custom pixel format and size. More...
 

Detailed Description

The IVideo resource object interface.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IVideo::GetObjectInterface ( )
pure virtual

Get the mutable Resource::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IVideo::GetObjectInterface ( ) const
pure virtual

Get the constant Resource::IObject interface.

Returns
The IObject interface.

◆ GetNumberOfStreams()

virtual UInt32 Murl::Resource::IVideo::GetNumberOfStreams ( ) const
pure virtual

Get the number of individual video streams.

Returns
The number of streams.

◆ CreateStream() [1/2]

virtual IVideoStream* Murl::Resource::IVideo::CreateStream ( UInt32  streamIndex,
IEnums::MipMapGenerationMode  mipMapGen 
) const
pure virtual

Create an IVideoStream object from the resource, with default pixel format and size.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
mipMapGenThe MIP map generation mode.
Returns
The newly created stream object, or null if failed.

◆ CreateStream() [2/2]

virtual IVideoStream* Murl::Resource::IVideo::CreateStream ( UInt32  streamIndex,
IEnums::PixelFormat  pixelFormat,
UInt32  pixelSizeX,
UInt32  pixelSizeY,
UInt32  divisor,
IEnums::MipMapGenerationMode  mipMapGen 
) const
pure virtual

Create an IVideoStream object from the resource, with custom pixel format and size.

Parameters
streamIndexThe index of the stream, from 0 to GetNumberOfStreams()-1.
pixelFormatThe desired pixel format.
pixelSizeXThe horizontal size of the stream in pixels, at the base MIP level.
pixelSizeYThe vertical size of the stream in pixels, at the base MIP level.
divisorAn optional power-of-two prescale factor (use 1 for a 1:1 image).
mipMapGenThe MIP map generation mode.
Returns
The newly created stream object, or null if failed.

The documentation for this interface was generated from the following file:
  • murl_resource_i_video.h


Copyright © 2011-2018 Spraylight GmbH.