| 1 | ############################################################ | ||
| 2 | # | ||
| 3 | # OpenGL::Shader::Common - Copyright 2007 Graphcomp - ALL RIGHTS RESERVED | ||
| 4 | # Author: Bob "grafman" Free - grafman@graphcomp.com | ||
| 5 | # | ||
| 6 | # This program is free software; you can redistribute it and/or | ||
| 7 | # modify it under the same terms as Perl itself. | ||
| 8 | # | ||
| 9 | ############################################################ | ||
| 10 | |||
| 11 | package OpenGL::Shader::Common; | ||
| 12 | |||
| 13 | require Exporter; | ||
| 14 | |||
| 15 | use Carp; | ||
| 16 | |||
| 17 | use vars qw($VERSION @ISA); | ||
| 18 | $VERSION = '1.01'; | ||
| 19 | |||
| 20 | @ISA = qw(Exporter); | ||
| 21 | |||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | OpenGL::Shader::Common - copyright 2007 Graphcomp - ALL RIGHTS RESERVED | ||
| 26 | Author: Bob "grafman" Free - grafman@graphcomp.com | ||
| 27 | |||
| 28 | This program is free software; you can redistribute it and/or | ||
| 29 | modify it under the same terms as Perl itself. | ||
| 30 | |||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This module provides a base class for OpenGL shader types. | ||
| 35 | Requires the OpenGL module. | ||
| 36 | |||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | ########## | ||
| 41 | # Instantiate a shader | ||
| 42 | |||
| 43 | use OpenGL::Shader; | ||
| 44 | my $shdr = new OpenGL::Shader(); | ||
| 45 | |||
| 46 | |||
| 47 | ########## | ||
| 48 | # Methods defined in this module: | ||
| 49 | |||
| 50 | # Get shader type. | ||
| 51 | my $type = $shdr->GetType(); | ||
| 52 | |||
| 53 | # Get shader version | ||
| 54 | my $ver = $shdr->GetVersion(); | ||
| 55 | |||
| 56 | # Get shader description | ||
| 57 | my $desc = $shdr->GetDescription(); | ||
| 58 | |||
| 59 | # Load shader files. | ||
| 60 | my $stat = $shdr->LoadFiles($fragment_file,$vertex_file); | ||
| 61 | |||
| 62 | # Get shader GL constants. | ||
| 63 | my $fragment_const = $shdr->GetFragmentConstant(); | ||
| 64 | my $vertex_const = $shdr->GetVertexConstant(); | ||
| 65 | |||
| 66 | # Get objects. | ||
| 67 | my $fragment_shader = $shdr->GetFragmentShader(); | ||
| 68 | my $vertex_shader = $shdr->GetVertexShader(); | ||
| 69 | my $program = $shdr->GetProgram(); | ||
| 70 | |||
| 71 | |||
| 72 | ########## | ||
| 73 | # Methods defined in subclasses: | ||
| 74 | |||
| 75 | # Load shader text. | ||
| 76 | $shdr->Load($fragment,$vertex); | ||
| 77 | |||
| 78 | # Enable shader. | ||
| 79 | $shdr->Enable(); | ||
| 80 | |||
| 81 | # Set Vertex Attribute | ||
| 82 | my $attr_id = $self->MapAttr($attr_name); | ||
| 83 | glVertexAttrib4fARB($attr_id,$x,$y,$z,$w); | ||
| 84 | |||
| 85 | # Get Global Variable ID (uniform/env) | ||
| 86 | my $var_id = $self->Map($var_name); | ||
| 87 | |||
| 88 | # Set float4 vector variable | ||
| 89 | $stat = $self->SetVector($var_name,$x,$y,$z,$w); | ||
| 90 | |||
| 91 | # Set float4x4 matrix via OGA | ||
| 92 | $stat = $self->SetMatrix($var_name,$oga); | ||
| 93 | |||
| 94 | # Disable shader. | ||
| 95 | $shdr->Disable(); | ||
| 96 | |||
| 97 | # Destructor. | ||
| 98 | $shdr->DESTROY(); | ||
| 99 | |||
| 100 | =cut | ||
| 101 | |||
| 102 | |||
| 103 | # Base constructor | ||
| 104 | sub new | ||
| 105 | { | ||
| 106 | my $this = shift; | ||
| 107 | my $class = ref($this) || $this; | ||
| 108 | my($type) = @_; | ||
| 109 | my $self = {type => uc($type)}; | ||
| 110 | bless($self,$class); | ||
| 111 | |||
| 112 | return $self; | ||
| 113 | } | ||
| 114 | |||
| 115 | |||
| 116 | # Get shader type | ||
| 117 | sub GetType | ||
| 118 | { | ||
| 119 | my($self) = @_; | ||
| 120 | return $self->{type}; | ||
| 121 | } | ||
| 122 | |||
| 123 | |||
| 124 | # Get shader version | ||
| 125 | sub GetVersion | ||
| 126 | { | ||
| 127 | my($self) = @_; | ||
| 128 | return $self->{version}; | ||
| 129 | } | ||
| 130 | |||
| 131 | |||
| 132 | # Get shader description | ||
| 133 | sub GetDescription | ||
| 134 | { | ||
| 135 | my($self) = @_; | ||
| 136 | return $self->{description}; | ||
| 137 | } | ||
| 138 | |||
| 139 | |||
| 140 | # Get fragment shader constant | ||
| 141 | sub GetFragmentConstant | ||
| 142 | { | ||
| 143 | my($self) = @_; | ||
| 144 | return $self->{fragment_const}; | ||
| 145 | } | ||
| 146 | |||
| 147 | |||
| 148 | # Get vertex shader constant | ||
| 149 | sub GetVertexConstant | ||
| 150 | { | ||
| 151 | my($self) = @_; | ||
| 152 | return $self->{vertex_const}; | ||
| 153 | } | ||
| 154 | |||
| 155 | |||
| 156 | # Get fragment shader ID | ||
| 157 | sub GetFragmentShader | ||
| 158 | { | ||
| 159 | my($self) = @_; | ||
| 160 | return $self->{fragment_id}; | ||
| 161 | } | ||
| 162 | |||
| 163 | |||
| 164 | # Get vertex shader ID | ||
| 165 | sub GetVertexShader | ||
| 166 | { | ||
| 167 | my($self) = @_; | ||
| 168 | return $self->{vertex_id}; | ||
| 169 | } | ||
| 170 | |||
| 171 | |||
| 172 | # Get shader program object | ||
| 173 | sub GetProgram | ||
| 174 | { | ||
| 175 | my($self) = @_; | ||
| 176 | return $self->{program}; | ||
| 177 | } | ||
| 178 | |||
| 179 | |||
| 180 | # Load shader files | ||
| 181 | sub LoadFiles | ||
| 182 | { | ||
| 183 | my($self,$fragment_file,$vertex_file) = @_; | ||
| 184 | |||
| 185 | my $fragment = ''; | ||
| 186 | if ($fragment_file) | ||
| 187 | { | ||
| 188 | return "Does not exist: $fragment_file" if (!-e $fragment_file); | ||
| 189 | $fragment = $self->read_file($fragment_file); | ||
| 190 | return "Empty fragment file" if (!$fragment); | ||
| 191 | } | ||
| 192 | |||
| 193 | my $vertex = ''; | ||
| 194 | if ($fragment_file) | ||
| 195 | { | ||
| 196 | return "Does not exist: $vertex_file" if (!-e $vertex_file); | ||
| 197 | $vertex = $self->read_file($vertex_file); | ||
| 198 | return "Empty vertex file" if (!$vertex); | ||
| 199 | } | ||
| 200 | |||
| 201 | return $self->Load($fragment,$vertex); | ||
| 202 | } | ||
| 203 | |||
| 204 | |||
| 205 | # Read file | ||
| 206 | sub read_file | ||
| 207 | { | ||
| 208 | my($self,$file) = @_; | ||
| 209 | |||
| 210 | return undef if (!open(FILE,$file)); | ||
| 211 | my @data = <FILE>; | ||
| 212 | close(FILE); | ||
| 213 | return join('',@data); | ||
| 214 | } | ||
| 215 | |||
| 216 | |||
| 217 | 1; | ||
| 218 | __END__ |