Class: RGSS::Renderable

Inherits:

Entity

Object
Entity
RGSS::Renderable

show all

Includes:: GL

Defined in:: lib/rgss/renderable.rb

Direct Known Subclasses

Plane, Sprite, Viewport

Constant Summary collapse

VERTICES_COUNT =

VERTICES_SIZE =

SIZEOF_FLOAT * VERTICES_COUNT

VERTICES_STRIDE =

SIZEOF_FLOAT * 4

Constants included from GL

Class Attribute Summary collapse

.color_id ⇒ Object readonly
Returns the value of attribute color_id.
.flash_id ⇒ Object readonly
Returns the value of attribute flash_id.
.hue_id ⇒ Object readonly
Returns the value of attribute hue_id.
.model_id ⇒ Object readonly
Returns the value of attribute model_id.
.opacity_id ⇒ Object readonly
Returns the value of attribute opacity_id.
.projection_id ⇒ Object readonly
Returns the value of attribute projection_id.
.tone_id ⇒ Object readonly
Returns the value of attribute tone_id.

Instance Attribute Summary collapse

Class Method Summary collapse

.shader ⇒ Object

Instance Method Summary collapse

#dispose ⇒ Object
#flash(color, duration) ⇒ Object
#flashing? ⇒ Boolean
#initialize(parent) ⇒ Renderable constructor
A new instance of Renderable.
#parent ⇒ Object protected
#render(delta) ⇒ Object
#update(delta) ⇒ Object
#vertex_setup(vertices = nil, indices = nil, vbo_usage = GL_DYNAMIC_DRAW, ebo_usage = GL_STATIC_DRAW) ⇒ Object protected
#z=(value) ⇒ Object

Methods included from GL

glActiveTexture, glAttachShader, glBeginConditionalRender, glBeginQuery, glBeginTransformFeedback, glBindAttribLocation, glBindBuffer, glBindBufferBase, glBindBufferRange, glBindFragDataLocation, glBindFragDataLocationIndexed, glBindFramebuffer, glBindRenderbuffer, glBindSampler, glBindTexture, glBindVertexArray, glBlendColor, glBlendEquation, glBlendEquationSeparate, glBlendFunc, glBlendFuncSeparate, glBlitFramebuffer, glBufferData, glBufferSubData, glCheckFramebufferStatus, glClampColor, glClear, glClearBufferfi, glClearBufferfv, glClearBufferiv, glClearBufferuiv, glClearColor, glClearDepth, glClearStencil, glClientWaitSync, glColorMask, glColorMaski, glColorP3ui, glColorP3uiv, glColorP4ui, glColorP4uiv, glCompileShader, glCompressedTexImage1D, glCompressedTexImage2D, glCompressedTexImage3D, glCompressedTexSubImage1D, glCompressedTexSubImage2D, glCompressedTexSubImage3D, glCopyBufferSubData, glCopyTexImage1D, glCopyTexImage2D, glCopyTexSubImage1D, glCopyTexSubImage2D, glCopyTexSubImage3D, glCreateProgram, glCreateShader, glCullFace, glDeleteBuffer, glDeleteBuffers, glDeleteFramebuffer, glDeleteFramebuffers, glDeleteProgram, glDeleteQueries, glDeleteQuery, glDeleteRenderbuffer, glDeleteRenderbuffers, glDeleteSampler, glDeleteSamplers, glDeleteShader, glDeleteSync, glDeleteTexture, glDeleteTextures, glDeleteVertexArray, glDeleteVertexArrays, glDepthFunc, glDepthMask, glDepthRange, glDetachShader, glDisable, glDisableVertexAttribArray, glDisablei, glDrawArrays, glDrawArraysInstanced, glDrawBuffer, glDrawBuffers, glDrawElements, glDrawElementsBaseVertex, glDrawElementsInstanced, glDrawElementsInstancedBaseVertex, glDrawRangeElements, glDrawRangeElementsBaseVertex, glEnable, glEnableVertexAttribArray, glEnablei, glEndConditionalRender, glEndQuery, glEndTransformFeedback, glFenceSync, glFinish, glFlush, glFlushMappedBufferRange, glFramebufferRenderbuffer, glFramebufferTexture, glFramebufferTexture1D, glFramebufferTexture2D, glFramebufferTexture3D, glFramebufferTextureLayer, glFrontFace, glGenBuffer, glGenBuffers, glGenFramebuffer, glGenFramebuffers, glGenQueries, glGenQuery, glGenRenderbuffer, glGenRenderbuffers, glGenSampler, glGenSamplers, glGenTexture, glGenTextures, glGenVertexArray, glGenVertexArrays, glGenerateMipmap, glGetActiveAttrib, glGetActiveUniform, glGetActiveUniformBlockName, glGetActiveUniformBlockiv, glGetActiveUniformName, glGetActiveUniformsiv, glGetAttachedShaders, glGetAttribLocation, glGetBooleani_v, glGetBooleanv, glGetBufferParameteri64v, glGetBufferParameteriv, glGetBufferPointerv, glGetBufferSubData, glGetCompressedTexImage, glGetDoublev, glGetError, glGetFloat, glGetFloatv, glGetFragDataIndex, glGetFragDataLocation, glGetFramebufferAttachmentParameteriv, glGetInteger, glGetInteger64i_v, glGetInteger64v, glGetIntegeri_v, glGetIntegerv, glGetMultisamplefv, glGetProgramInfoLog, glGetProgramiv, glGetQueryObjecti64v, glGetQueryObjectiv, glGetQueryObjectui64v, glGetQueryObjectuiv, glGetQueryiv, glGetRenderbufferParameteriv, glGetSamplerParameterIiv, glGetSamplerParameterIuiv, glGetSamplerParameterfv, glGetSamplerParameteriv, glGetShaderInfoLog, glGetShaderSource, glGetShaderiv, glGetString, glGetStringi, glGetSynciv, glGetTexImage, glGetTexLevelParameterfv, glGetTexLevelParameteriv, glGetTexParameterIiv, glGetTexParameterIuiv, glGetTexParameterfv, glGetTexParameteriv, glGetTransformFeedbackVarying, glGetUniformBlockIndex, glGetUniformIndices, glGetUniformLocation, glGetUniformfv, glGetUniformiv, glGetUniformuiv, glGetVertexAttribIiv, glGetVertexAttribIuiv, glGetVertexAttribPointerv, glGetVertexAttribdv, glGetVertexAttribfv, glGetVertexAttribiv, glHint, glIsBuffer, glIsEnabled, glIsEnabledi, glIsFramebuffer, glIsProgram, glIsQuery, glIsRenderbuffer, glIsSampler, glIsShader, glIsSync, glIsTexture, glIsVertexArray, glLineWidth, glLinkProgram, glLogicOp, glMapBuffer, glMapBufferRange, glMultiDrawArrays, glMultiDrawElements, glMultiDrawElementsBaseVertex, glMultiTexCoordP1ui, glMultiTexCoordP1uiv, glMultiTexCoordP2ui, glMultiTexCoordP2uiv, glMultiTexCoordP3ui, glMultiTexCoordP3uiv, glMultiTexCoordP4ui, glMultiTexCoordP4uiv, glNormalP3ui, glNormalP3uiv, glPixelStoref, glPixelStorei, glPointParameterf, glPointParameterfv, glPointParameteri, glPointParameteriv, glPointSize, glPolygonMode, glPolygonOffset, glPrimitiveRestartIndex, glProvokingVertex, glQueryCounter, glReadBuffer, glReadPixels, glRenderbufferStorage, glRenderbufferStorageMultisample, glSampleCoverage, glSampleMaski, glSamplerParameterIiv, glSamplerParameterIuiv, glSamplerParameterf, glSamplerParameterfv, glSamplerParameteri, glSamplerParameteriv, glScissor, glSecondaryColorP3ui, glSecondaryColorP3uiv, glShaderSource, glStencilFunc, glStencilFuncSeparate, glStencilMask, glStencilMaskSeparate, glStencilOp, glStencilOpSeparate, glTexBuffer, glTexCoordP1ui, glTexCoordP1uiv, glTexCoordP2ui, glTexCoordP2uiv, glTexCoordP3ui, glTexCoordP3uiv, glTexCoordP4ui, glTexCoordP4uiv, glTexImage1D, glTexImage2D, glTexImage2DMultisample, glTexImage3D, glTexImage3DMultisample, glTexParameterIiv, glTexParameterIuiv, glTexParameterf, glTexParameterfv, glTexParameteri, glTexParameteriv, glTexSubImage1D, glTexSubImage2D, glTexSubImage3D, glTransformFeedbackVaryings, glUniform1f, glUniform1fv, glUniform1i, glUniform1iv, glUniform1ui, glUniform1uiv, glUniform2f, glUniform2fv, glUniform2i, glUniform2iv, glUniform2ui, glUniform2uiv, glUniform3f, glUniform3fv, glUniform3i, glUniform3iv, glUniform3ui, glUniform3uiv, glUniform4f, glUniform4fv, glUniform4i, glUniform4iv, glUniform4ui, glUniform4uiv, glUniformBlockBinding, glUniformMatrix2fv, glUniformMatrix2x3fv, glUniformMatrix2x4fv, glUniformMatrix3fv, glUniformMatrix3x2fv, glUniformMatrix3x4fv, glUniformMatrix4fv, glUniformMatrix4x2fv, glUniformMatrix4x3fv, glUnmapBuffer, glUseProgram, glValidateProgram, glVertexAttrib1d, glVertexAttrib1dv, glVertexAttrib1f, glVertexAttrib1fv, glVertexAttrib1s, glVertexAttrib1sv, glVertexAttrib2d, glVertexAttrib2dv, glVertexAttrib2f, glVertexAttrib2fv, glVertexAttrib2s, glVertexAttrib2sv, glVertexAttrib3d, glVertexAttrib3dv, glVertexAttrib3f, glVertexAttrib3fv, glVertexAttrib3s, glVertexAttrib3sv, glVertexAttrib4Nbv, glVertexAttrib4Niv, glVertexAttrib4Nsv, glVertexAttrib4Nub, glVertexAttrib4Nubv, glVertexAttrib4Nuiv, glVertexAttrib4Nusv, glVertexAttrib4bv, glVertexAttrib4d, glVertexAttrib4dv, glVertexAttrib4f, glVertexAttrib4fv, glVertexAttrib4iv, glVertexAttrib4s, glVertexAttrib4sv, glVertexAttrib4ubv, glVertexAttrib4uiv, glVertexAttrib4usv, glVertexAttribDivisor, glVertexAttribI1i, glVertexAttribI1iv, glVertexAttribI1ui, glVertexAttribI1uiv, glVertexAttribI2i, glVertexAttribI2iv, glVertexAttribI2ui, glVertexAttribI2uiv, glVertexAttribI3i, glVertexAttribI3iv, glVertexAttribI3ui, glVertexAttribI3uiv, glVertexAttribI4bv, glVertexAttribI4i, glVertexAttribI4iv, glVertexAttribI4sv, glVertexAttribI4ubv, glVertexAttribI4ui, glVertexAttribI4uiv, glVertexAttribI4usv, glVertexAttribIPointer, glVertexAttribP1ui, glVertexAttribP1uiv, glVertexAttribP2ui, glVertexAttribP2uiv, glVertexAttribP3ui, glVertexAttribP3uiv, glVertexAttribP4ui, glVertexAttribP4uiv, glVertexAttribPointer, glVertexP2ui, glVertexP2uiv, glVertexP3ui, glVertexP3uiv, glVertexP4ui, glVertexP4uiv, glViewport, glWaitSync

Constructor Details

#initialize(parent) ⇒ `Renderable`

Returns a new instance of Renderable.

# File 'lib/rgss/renderable.rb', line 69

def initialize(parent)
  super()
  @parent = parent.is_a?(RGSS::Batch) ? parent : Graphics.batch
  @parent.add(self)

  @visible = true
  @color = Color::NONE
  @tone = Tone.new(0, 0, 0, 0)
  @flash_color = Color::NONE
  @flash_duration = -1
  @hue = 0.0
  @opacity = 1.0
  @blend = Blend.default
end

Class Attribute Details

.color_id ⇒ `Object` (readonly)

Returns the value of attribute color_id.



16
17
18

# File 'lib/rgss/renderable.rb', line 16

def color_id
  @color_id
end

.flash_id ⇒ `Object` (readonly)

Returns the value of attribute flash_id.



20
21
22

# File 'lib/rgss/renderable.rb', line 20

def flash_id
  @flash_id
end

.hue_id ⇒ `Object` (readonly)

Returns the value of attribute hue_id.



18
19
20

# File 'lib/rgss/renderable.rb', line 18

def hue_id
  @hue_id
end

.model_id ⇒ `Object` (readonly)

Returns the value of attribute model_id.



15
16
17

# File 'lib/rgss/renderable.rb', line 15

def model_id
  @model_id
end

.opacity_id ⇒ `Object` (readonly)

Returns the value of attribute opacity_id.



19
20
21

# File 'lib/rgss/renderable.rb', line 19

def opacity_id
  @opacity_id
end

.projection_id ⇒ `Object` (readonly)

Returns the value of attribute projection_id.



14
15
16

# File 'lib/rgss/renderable.rb', line 14

def projection_id
  @projection_id
end

.tone_id ⇒ `Object` (readonly)

Returns the value of attribute tone_id.



17
18
19

# File 'lib/rgss/renderable.rb', line 17

def tone_id
  @tone_id
end

Instance Attribute Details

#blend ⇒ `Blend`

Returns:

(Blend)



67
68
69

# File 'lib/rgss/renderable.rb', line 67

def blend
  @blend
end

#color ⇒ `Color`

Returns:

(Color)



43
44
45

# File 'lib/rgss/renderable.rb', line 43

def color
  @color
end

#flash_color ⇒ `Color` (readonly)

Returns:

(Color)



59
60
61

# File 'lib/rgss/renderable.rb', line 59

def flash_color
  @flash_color
end

#hue ⇒ `Float`

Returns:

(Float)



51
52
53

# File 'lib/rgss/renderable.rb', line 51

def hue
  @hue
end

#opacity ⇒ `Float`

Returns:

(Float)



55
56
57

# File 'lib/rgss/renderable.rb', line 55

def opacity
  @opacity
end

#tone ⇒ `Tone`

Returns:

(Tone)



47
48
49

# File 'lib/rgss/renderable.rb', line 47

def tone
  @tone
end

#visible ⇒ `Boolean`

Returns:

(Boolean)



63
64
65

# File 'lib/rgss/renderable.rb', line 63

def visible
  @visible
end

Class Method Details

.shader ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 22

def shader
  return @shader if @shader

  v = File.read(File.join(__dir__, 'shaders', 'sprite-vert.glsl'))
  f = File.read(File.join(__dir__, 'shaders', 'sprite-frag.glsl'))

  @shader = Shader.new(v, f)
  @projection_id = @shader.locate('projection')
  @model_id = @shader.locate('model')
  @hue_id = @shader.locate('hue')
  @color_id = @shader.locate('color')
  @tone_id = @shader.locate('tone')
  @flash_id = @shader.locate('flash')
  @opacity_id = @shader.locate('opacity')
  @shader
end

Instance Method Details

#dispose ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 84

def dispose
  @parent&.remove(self)
  glDeleteVertexArray(@vao) if @vao
  glDeleteBuffer(@vbo) if @vbo
  glDeleteBuffer(@ebo) if @ebo
end

#flash(color, duration) ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 107

def flash(color, duration)
  @flash_color = color
  @flash_duration = duration
end

#flashing? ⇒ `Boolean`

Returns:

(Boolean)



91
92
93

# File 'lib/rgss/renderable.rb', line 91

def flashing?
  @flash_duration > -1
end

#parent ⇒ `Object` (protected)



135
136
137

# File 'lib/rgss/renderable.rb', line 135

def parent
  @parent
end

#render(delta) ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 112

def render(delta)

  if @blend
    glBlendEquation(@blend.op)
    glBlendFunc(@blend.src, @blend.dst)
  end

  Renderable.shader.use
  glUniformMatrix4fv(Renderable.model_id, 1, false, self.model)
  glUniform4fv(Renderable.color_id, 1, self.color)
  glUniform4fv(Renderable.tone_id, 1, self.tone)
  glUniform4fv(Renderable.flash_id, 1, self.flash_color)
  glUniform1f(Renderable.hue_id, self.hue)
  glUniform1f(Renderable.opacity_id, self.opacity)
end

#update(delta) ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 99

def update(delta)
  super
  if @flash_duration > -1
    @flash_duration -= 1
    @flash_color = Color::NONE if @flash_duration < 0
  end
end

#vertex_setup(vertices = nil, indices = nil, vbo_usage = GL_DYNAMIC_DRAW, ebo_usage = GL_STATIC_DRAW) ⇒ `Object` (protected)

# File 'lib/rgss/renderable.rb', line 139

def vertex_setup(vertices = nil, indices = nil, vbo_usage = GL_DYNAMIC_DRAW, ebo_usage = GL_STATIC_DRAW)

  @vao = glGenVertexArray
  @vbo = glGenBuffer
  @ebo = glGenBuffer

  glBindVertexArray(@vao)
  glBindBuffer(GL_ARRAY_BUFFER, @vbo)
  glBufferData(GL_ARRAY_BUFFER, vertices&.bytesize || VERTICES_SIZE, vertices, vbo_usage)

  indices ||= [0, 1, 2, 0, 3, 1].pack('C*')
  glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, @ebo)
  glBufferData(GL_ELEMENT_ARRAY_BUFFER, indices.bytesize, indices, ebo_usage)

  glEnableVertexAttribArray(0)
  glVertexAttribPointer(0, 4, GL_FLOAT, false, SIZEOF_FLOAT * 4, nil)
  glBindVertexArray(GL_NONE)
end

#z=(value) ⇒ `Object`

# File 'lib/rgss/renderable.rb', line 128

def z=(value)
  @parent.invalidate
  super(value)
end

Class: RGSS::Renderable

Direct Known Subclasses

Constant Summary collapse

Constants included from GL

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GL

Constructor Details

#initialize(parent) ⇒ Renderable

Class Attribute Details

.color_id ⇒ Object (readonly)

.flash_id ⇒ Object (readonly)

.hue_id ⇒ Object (readonly)

.model_id ⇒ Object (readonly)

.opacity_id ⇒ Object (readonly)

.projection_id ⇒ Object (readonly)

.tone_id ⇒ Object (readonly)

Instance Attribute Details

#blend ⇒ Blend

#color ⇒ Color

#flash_color ⇒ Color (readonly)

#hue ⇒ Float

#opacity ⇒ Float

#tone ⇒ Tone

#visible ⇒ Boolean

Class Method Details

.shader ⇒ Object

Instance Method Details

#dispose ⇒ Object

#flash(color, duration) ⇒ Object

#flashing? ⇒ Boolean

#parent ⇒ Object (protected)

#render(delta) ⇒ Object

#update(delta) ⇒ Object

#vertex_setup(vertices = nil, indices = nil, vbo_usage = GL_DYNAMIC_DRAW, ebo_usage = GL_STATIC_DRAW) ⇒ Object (protected)

#z=(value) ⇒ Object

#initialize(parent) ⇒ `Renderable`

.color_id ⇒ `Object` (readonly)

.flash_id ⇒ `Object` (readonly)

.hue_id ⇒ `Object` (readonly)

.model_id ⇒ `Object` (readonly)

.opacity_id ⇒ `Object` (readonly)

.projection_id ⇒ `Object` (readonly)

.tone_id ⇒ `Object` (readonly)

#blend ⇒ `Blend`

#color ⇒ `Color`

#flash_color ⇒ `Color` (readonly)

#hue ⇒ `Float`

#opacity ⇒ `Float`

#tone ⇒ `Tone`

#visible ⇒ `Boolean`

.shader ⇒ `Object`

#dispose ⇒ `Object`

#flash(color, duration) ⇒ `Object`

#flashing? ⇒ `Boolean`

#parent ⇒ `Object` (protected)

#render(delta) ⇒ `Object`

#update(delta) ⇒ `Object`

#vertex_setup(vertices = nil, indices = nil, vbo_usage = GL_DYNAMIC_DRAW, ebo_usage = GL_STATIC_DRAW) ⇒ `Object` (protected)

#z=(value) ⇒ `Object`