dox/Rendering/OpenGL/vtkShader2.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkShader2.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkShader2_h
#define __vtkShader2_h

#include "vtkRenderingOpenGLModule.h" // For export macro
#include "vtkObject.h"

// Values for GetType()/SetType()
enum vtkShader2Type
{
  VTK_SHADER_TYPE_VERTEX = 0,
  VTK_SHADER_TYPE_TESSELLATION_CONTROL = 3, // new, not supported yet
  VTK_SHADER_TYPE_TESSELLATION_EVALUATION = 4, // new, not supported yet
  VTK_SHADER_TYPE_GEOMETRY = 1,
  VTK_SHADER_TYPE_FRAGMENT = 2
};

class vtkOpenGLRenderWindow;
class vtkUniformVariables;

class VTKRENDERINGOPENGL_EXPORT vtkShader2 : public vtkObject
{
public:
  static vtkShader2 *New();
  vtkTypeMacro(vtkShader2,vtkObject);
  void PrintSelf(ostream &os, vtkIndent indent);


  static bool IsSupported(vtkOpenGLRenderWindow *context);
  static bool LoadExtensions(vtkOpenGLRenderWindow *context);


  vtkGetStringMacro(SourceCode);
  vtkSetStringMacro(SourceCode);


  vtkGetMacro(Type,int);


  vtkSetMacro(Type,int);

  const char *GetTypeAsString();

  void Compile();

  bool GetLastCompileStatus();

  const char *GetLastCompileLog();


  void SetContext(vtkOpenGLRenderWindow *context);
  vtkGetObjectMacro(Context,vtkOpenGLRenderWindow);

  virtual void ReleaseGraphicsResources();


  vtkGetMacro(Id,unsigned int);


  vtkGetObjectMacro(UniformVariables,vtkUniformVariables);
  virtual void SetUniformVariables(vtkUniformVariables *variables);

protected:
  vtkShader2();

  virtual ~vtkShader2();

  char *SourceCode;
  int Type;

  unsigned int Id; // actually GLuint. Initial value is 0.

  bool LastCompileStatus; // Initial value is false.
  char *LastCompileLog; // Initial value is the empty string ""='\0'.
  size_t LastCompileLogCapacity; // Initial value is 8.

  vtkTimeStamp LastCompileTime;
  vtkUniformVariables *UniformVariables; // Initial values is an empty list
  vtkOpenGLRenderWindow *Context;

  bool ExtensionsLoaded;
  bool SupportGeometryShader;

private:
  vtkShader2(const vtkShader2&); // Not implemented.
  void operator=(const vtkShader2&); // Not implemented.
};

#endif