IGameFX.h

Go to the documentation of this file.

/**********************************************************************
*<
FILE: IGameFX.h

DESCRIPTION: D3D Effect interfaces for IGame

CREATED BY: Neil Hazzard,  Autodesk Ltd

HISTORY: created 06/25/05

IGame Version: 1.122

*>  Copyright (c) 2005, All Rights Reserved.
**********************************************************************/
#pragma once

#include "..\maxheap.h"
#include "..\BuildWarnings.h"
#include "..\strclass.h"

// forward declarations
class IGameNode;
class IGameProperty;
class IGameFXProperty;
class IGameFXTechnique;
class IGameFXFunction;
namespace MaxSDK
{
    namespace AssetManagement
    {
        class AssetUser;
    }
}
class Mtl;


class IGameFX: public MaxHeapOperators
{

public:

    enum EffectSource{
        kFile,          
        kBuffer         
    };

    enum IGameFXProfile{
        kVSPS_20,       
        kVSPS_2X,       
        kVSPS_30        
    };
    virtual ~IGameFX() {;}

    virtual bool Initialize(const MaxSDK::AssetManagement::AssetUser& effect, EffectSource input)=0;

    virtual bool ParseData(Mtl * effectMtl)=0;

    virtual const MCHAR* GetError()=0;

    virtual int GetNumberOfProperties()=0;

    virtual IGameFXProperty * GetIGameFXProperty(int index)=0;

    virtual int GetNumberOfTechniques()=0;

    virtual IGameFXTechnique* GetIGameFXTechnique(int index)=0;

    virtual int GetNumberOfFunctions() =0 ;

    virtual IGameFXFunction * GetIGameFXFunction(int index) = 0;

    virtual const MaxSDK::AssetManagement::AssetUser & GetEffectFile() = 0;
};



class IGameFXProperty: public MaxHeapOperators
{
public:

    enum IGameFXPropUsage{
        IGAMEFX_GENERAL,    
        IGAMEFX_SAMPLER,    
        IGAMEFX_LIGHT,      
        IGAMEFX_TEXTURE     
    };
    virtual ~IGameFXProperty() {;}


    virtual IGameProperty * GetIGameProperty() =0;

    virtual IGameFXPropUsage GetPropertyUsage()=0;

    virtual const MCHAR * GetFXSemantic()=0;

    virtual int GetNumberOfFXAnnotations()=0;

    virtual bool GetFXAnnotation(int index, MSTR * languageType, MSTR * key, MSTR * value)=0;

    virtual const MCHAR * GetFXDefaultValue()=0;

    virtual int GetNumberofFXPipeStates()=0;

    virtual bool GetPipeStates(int index, MSTR * key, MSTR *value)=0;

    virtual const MCHAR * GetPropertyName()=0;

    virtual const MCHAR * GetPropertyType() = 0;

    virtual IGameNode * GetBindingNode() = 0;
};


class IGameFXPass: public MaxHeapOperators{
public:
    virtual ~IGameFXPass() {;}

    virtual const MCHAR * GetPassName()=0;

    virtual int GetNumberOfFXAnnotations()=0;

    virtual bool GetFXAnnotation(int index, MSTR * languageType, MSTR * key, MSTR * value)=0;

    virtual int GetNumberofFXPipeStates()=0;

    virtual bool GetPipeStates(int index, MSTR * key, MSTR *value)=0;


    virtual bool GetVertexShader(MSTR * entry, MSTR * code)=0;
    

    virtual bool GetPixelShader(MSTR * entry, MSTR * code)=0;

    virtual IGameFX::IGameFXProfile GetTargetProfile()=0;
};

class IGameFXTechnique: public MaxHeapOperators
{
public:
    virtual ~IGameFXTechnique() {;}

    virtual int GetNumberOfPasses()=0;

    virtual const MCHAR * GetTechniqueName()=0;

    virtual int GetNumberOfFXAnnotations()=0;

    virtual bool GetFXAnnotation(int index, MSTR * languageType, MSTR * key, MSTR * value)=0;

    virtual IGameFXPass * GetIGameFXPass(int index)=0;
};

class IGameFXFunction: public MaxHeapOperators
{
public:
    virtual ~IGameFXFunction() {;}

    virtual const MCHAR * GetFunctionBody()=0;

    virtual const MCHAR * GetFunctionName()=0;
};