shdinterface.h

Go to the documentation of this file.

/*
**  Command & Conquer Generals Zero Hour(tm)
**  Copyright 2025 Electronic Arts Inc.
**
**  This program is free software: you can redistribute it and/or modify
**  it under the terms of the GNU General Public License as published by
**  the Free Software Foundation, either version 3 of the License, or
**  (at your option) any later version.
**
**  This program is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**  GNU General Public License for more details.
**
**  You should have received a copy of the GNU General Public License
**  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
 /***********************************************************************************************
 ***              C O N F I D E N T I A L  ---  W E S T W O O D  S T U D I O S               ***
 ***********************************************************************************************
 *                                                                                             *
 *                 Project Name : WWSHADE                                                         *
 *                                                                                             *
 *                     $Archive:: wwshade/shdinterface.h                           $*
 *                                                                                             *
 *                  $Org Author:: Jani_p
 *                                                                                                                                  
 *                      $Author:: Kenny_m
 *                                                                                                                                  
 *                            $Modtime:: 6/05/02 3:12p                                               $*
 *                                                                                             *
 *                    $Revision:: 2                                                          $*
 *                                                                                             *
 *   6/05/02     KJM : Added texture info functions
 *---------------------------------------------------------------------------------------------*
 * Functions:                                                                                  *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 
#ifndef SHDINTERFACE_H
#define SHDINTERFACE_H
 
#include "always.h"
#include "refcount.h"
#include "dx8wrapper.h"
 
class ShdDefClass;
class ShdMeshClass;
class RenderInfoClass;
class TextureClass;
 
/*
** Maximum passes allowed for any shader implementation!
*/
const int SHD_MAX_PASSES = 4;

struct VertexStreamStruct
{
    VertexStreamStruct()
    :   Locations(0),
        Normals(0),
        DiffuseInt(0),
        DiffuseFloat(0)
    {
        for (int i=0;i<MAX_TEXTURE_STAGES;++i) 
        {
            UV[i]=0;
        }
    }
        
    const Vector3* Locations;
    const Vector3* Normals;
    const Vector2* UV[MAX_TEXTURE_STAGES];
    const unsigned* DiffuseInt;
    const Vector4* DiffuseFloat;
    const Vector3*   S;
    const Vector3* T;
    const Vector3* SxT;
};
 

class ShdInterfaceClass : public RefCountClass
{
public:
    ShdInterfaceClass(const ShdDefClass * def,int class_id);
    virtual ~ShdInterfaceClass(void);
    
    const ShdDefClass *      Peek_Definition(void);   
 
    WWINLINE int            Get_Class_ID() const { return ClassID; }
 
    // For rendering efficiency, all shaders should implement comparison operator that the renderer
    // can use to sort the meshes.
    virtual bool Greater_Than   (const ShdInterfaceClass& s,int pass) const { return true; }
    virtual bool Similar_Enough   (const ShdInterfaceClass& s,int pass) const { return true; }
 
    virtual int                 Get_Pass_Count(void) = 0;
    virtual bool                Pass_Selection(ShdMeshClass*, RenderInfoClass*,int) { return true; }
 
    virtual void                Apply_Shared(int cur_pass, RenderInfoClass& rinfo) = 0;
    virtual void                Apply_Instance(int cur_pass, RenderInfoClass& rinfo) = 0;
 
    // The shader needs to tell how many vertex streams it needs and what are the sizes of vertices
    // in each stream.
    virtual unsigned            Get_Vertex_Stream_Count() const = 0;
    virtual unsigned            Get_Vertex_Size(unsigned stream) const = 0;
 
    virtual bool                Use_HW_Vertex_Processing() const = 0;
 
    virtual int                 Get_Texture_Count() const = 0;
    virtual TextureClass*   Peek_Texture(int idx) const = 0;
 
    // The shader needs to construct each vertex stream as requested. The data comes in a standard
    // VertexStreamStruct, and the shader can format it as it wishes (nothing else will be using
    // the buffer than the shader itself.
    virtual void                Copy_Vertex_Stream(unsigned stream, void* dest_buffer, const VertexStreamStruct& vss, unsigned vertex_count) = 0;
 
    // Return whether this shader is opaque.  This property is used to determine whether
    // geometric shadows should be cast from an object for example.  Alpha-Test shaders should
    // return false to Is_Opaque.
    virtual bool                Is_Opaque(void) const { return true; }
 
protected:
 
    const ShdDefClass *      Definition;
    int ClassID;
 
};
 
 
#endif //SHDINTERFACE_H