ihardwarematerial.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: IHardwareMaterial.h

    DESCRIPTION: Hardware Material Extension Interface class

    CREATED BY: Norbert Jeske

    HISTORY:

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

#include "baseinterface.h"
#include "color.h"
// forward declarations
class INode;


#ifndef __D3DX9_H__
#  include <d3dx9.h>
#endif


#define IHARDWARE_MATERIAL_INTERFACE_ID Interface_ID(0x40c926b7, 0x7b3a66b7)
#define IHARDWARE_MATERIAL2_INTERFACE_ID Interface_ID(0x43d32666, 0x3a4467b1)
#define IHARDWARE_MATERIAL3_INTERFACE_ID Interface_ID(0x63d72368, 0xcc4859e3)


enum MapUsageType
{
    MAPUSAGE_UNDEFINED = 0,
    MAPUSAGE_DIFFUSE = (1 << 0),
    MAPUSAGE_OPACITY = (1 << 1),
    MAPUSAGE_SPECULAR_COLOR = (1 << 2),
    MAPUSAGE_SPECULAR_LEVEL = (1 << 3),
    MAPUSAGE_GLOSSINESS = (1 << 4),
    MAPUSAGE_BUMP = (1 << 5),
    MAPUSAGE_SELF_ILLUM = (1 << 6),
    MAPUSAGE_FILTER_COLOR = (1 << 7),
    MAPUSAGE_REFLECTION = (1 << 8),
    MAPUSAGE_REFRACTION = (1 << 9),
    MAPUSAGE_DISPLACEMENT = (1 << 10),
    MAPUSAGE_DIFFUSE_OPACITY = MAPUSAGE_DIFFUSE|MAPUSAGE_OPACITY,
    MAPUSAGE_SPECULAR_COLOR_GLOSS = MAPUSAGE_SPECULAR_COLOR|MAPUSAGE_GLOSSINESS,
    MAPUSAGE_SPECULAR_LEVEL_GLOSS = MAPUSAGE_SPECULAR_LEVEL|MAPUSAGE_GLOSSINESS,
    MAPUSAGE_BUMP_GLOSS = MAPUSAGE_BUMP|MAPUSAGE_GLOSSINESS,
    MAPUSAGE_SELF_ILLUM_GLOSS = MAPUSAGE_SELF_ILLUM|MAPUSAGE_GLOSSINESS,
    MAPUSAGE_OPACITY_SPLEVEL = MAPUSAGE_OPACITY|MAPUSAGE_SPECULAR_LEVEL,
    MAPUSAGE_SUPPORT_PROGRAMMABLE_PIPELINE = (1 << 31),
};


class IHardwareMaterial : public BaseInterface
{
public:
    virtual Interface_ID    GetID() { return IHARDWARE_MATERIAL_INTERFACE_ID; }

    // Interface Lifetime
    virtual LifetimeType    LifetimeControl() { return noRelease; }

    // Information provided from a Custom Attribute?
    virtual void    SetCustomFlag(bool bVal) = 0;

    // Render States
    virtual void    SetFillMode(DWORD mode) = 0;
    virtual void    SetShadeMode(DWORD mode) = 0;

    // Material Colors
    virtual void    SetMaterial(LPD3DXMATERIAL pMtl) = 0;

    virtual void    SetDiffuseColor(LPD3DXCOLOR pClr) = 0;
    virtual void    SetDiffuseColor(Color c, float alpha = 1.0f) = 0;
    virtual void    SetDiffuseColor(Point3 c, float alpha = 1.0f) = 0;

    virtual void    SetAmbientColor(LPD3DXCOLOR pClr) = 0;
    virtual void    SetAmbientColor(Color c, float alpha = 1.0f) = 0;
    virtual void    SetAmbientColor(Point3 c, float alpha = 1.0f) = 0;

    virtual void    SetSpecularColor(LPD3DXCOLOR pClr) = 0;
    virtual void    SetSpecularColor(Color c, float alpha = 1.0f) = 0;
    virtual void    SetSpecularColor(Point3 c, float alpha = 1.0f) = 0;

    virtual void    SetEmissiveColor(LPD3DXCOLOR pClr) = 0;
    virtual void    SetEmissiveColor(Color c, float alpha = 1.0f) = 0;
    virtual void    SetEmissiveColor(Point3 c, float alpha = 1.0f) = 0;

    virtual void    SetSpecularPower(float power) = 0;

    // Texture States
    virtual bool    SetNumTexStages(DWORD numStages) = 0;
    virtual bool    SetTexture(DWORD stage, DWORD_PTR pTexture) = 0;
    virtual bool    SetTexture(DWORD stage, LPCSTR filename) = 0;
    virtual bool    SetTexture(DWORD stage, DWORD_PTR pTexture, MapUsageType usage) = 0;
    virtual bool    SetTexture(DWORD stage, LPCSTR filename, MapUsageType usage) = 0;

    virtual bool    SetTextureUVWSource(DWORD stage, DWORD type) = 0;
    virtual bool    SetTextureMapChannel(DWORD stage, DWORD numChan) = 0;
    virtual bool    SetTextureCoordIndex(DWORD stage, DWORD index) = 0;

    // Texture Transforms
    virtual bool    SetTextureTransformFlag(DWORD stage, DWORD flag) = 0;
    virtual bool    SetTextureTransform(DWORD stage, LPD3DXMATRIX pTransform) = 0;

    // Texture Stage States
    virtual bool    SetTextureColorOp(DWORD stage, DWORD colorOp) = 0;
    virtual bool    SetTextureColorArg(DWORD stage, DWORD argNum, DWORD colorArg) = 0;
    virtual bool    SetTextureAlphaOp(DWORD stage, DWORD alphaArg) = 0;
    virtual bool    SetTextureAlphaArg(DWORD stage, DWORD argNum, DWORD alphaArg) = 0;
    virtual bool    SetTextureAddressMode(DWORD stage, DWORD coordNum, DWORD mode) = 0;

    // Shaders
    virtual bool    SetVertexShader(DWORD_PTR pVertexShader) = 0;
    virtual bool    SetPixelShader(DWORD_PTR pPixelShader) = 0;

    // Effects
    virtual bool    SetEffect(DWORD_PTR pEffect) = 0;

    // User Plugin
    virtual bool    SetPlugin(BaseInterface *pPlugin) = 0;

    // Current Associated INode
    virtual bool    SetINode(INode *pINode) = 0;

    virtual void SetTextureFactor(DWORD factor) = 0;

    virtual void SetSpecularLevel(float level) = 0;

    
};


class IHardwareMaterial2 : public IHardwareMaterial
{
public:
    virtual void SetSelfIllumColorOn(BOOL bOn) = 0;
};

class IHardwareMaterial3 : public IHardwareMaterial2
{
public:
    virtual bool SetSamplerBorderColor(int stage, DWORD borderColor) = 0;
};