Uranium
Application Framework
UM.View.GL.OpenGL.OpenGL Class Reference

Classes

class  Vendor
 

Public Member Functions

def __init__ (self)
 
def hasFrameBufferObjects (self)
 
def getOpenGLVersion (self)
 
def getOpenGLShadingLanguageVersion (self)
 
def getGPUVendorName (self)
 
def getGPUVendor (self)
 
def getGPUType (self)
 
def getBindingsObject (self)
 
def createFrameBufferObject
 
def createTexture (self)
 
def createShaderProgram
 
def createVertexBuffer
 
def createIndexBuffer
 
def getInstance (cls, args, kwargs)
 

Static Public Attributes

string VertexBufferProperty = "__vertex_buffer"
 
string IndexBufferProperty = "__index_buffer"
 

Detailed Description

Convenience methods for dealing with OpenGL.

This class simplifies dealing with OpenGL and different Python OpenGL bindings. It
mostly describes an interface that should be implemented for dealing with basic OpenGL
functionality using these different OpenGL bindings. Additionally, it provides singleton
handling. The implementation-defined subclass must be set as singleton instance as soon
as possible so that any calls to getInstance() return a proper object.

Member Function Documentation

◆ createTexture()

def UM.View.GL.OpenGL.OpenGL.createTexture (   self,
  Texture 
)
Create a Texture Object.

This should return an implementation-specific Texture subclass.

◆ getBindingsObject()

def UM.View.GL.OpenGL.OpenGL.getBindingsObject (   self,
  Any 
)
Get the OpenGL bindings object.

This should return an object that has all supported OpenGL functions
as methods and additionally defines all OpenGL constants. This object
is used to make direct OpenGL calls so should match OpenGL as closely
as possible.

◆ getGPUType()

def UM.View.GL.OpenGL.OpenGL.getGPUType (   self,
  str 
)
Get a string describing the current GPU type.

This effectively should return the OpenGL renderer string.

◆ getGPUVendor()

def UM.View.GL.OpenGL.OpenGL.getGPUVendor (   self,
  int 
)
Get the current GPU vendor.

:return: One of the items of OpenGL.Vendor.

◆ getGPUVendorName()

def UM.View.GL.OpenGL.OpenGL.getGPUVendorName (   self,
  str 
)
Get the current GPU vendor name.

:return: Name of the vendor of current GPU

◆ getOpenGLShadingLanguageVersion()

def UM.View.GL.OpenGL.OpenGL.getOpenGLShadingLanguageVersion (   self,
  Version 
)
Get the current OpenGL shading language version.

:return: Shading language version of OpenGL

◆ getOpenGLVersion()

def UM.View.GL.OpenGL.OpenGL.getOpenGLVersion (   self,
  str 
)
Get the current OpenGL version.

:return: Version of OpenGL

◆ hasFrameBufferObjects()

def UM.View.GL.OpenGL.OpenGL.hasFrameBufferObjects (   self,
  bool 
)
Check if the current OpenGL implementation supports FrameBuffer Objects.

:return: True if FBOs are supported, False if not.

The documentation for this class was generated from the following file: