Rasterizer (bge.render)

Intro

# Example Uses an L{SCA_MouseSensor}, and two L{KX_ObjectActuator}s to implement MouseLook::
# To use a mouse movement sensor "Mouse" and a
# motion actuator to mouse look:
import bge

# scale sets the speed of motion
scale = 1.0, 0.5

co = bge.logic.getCurrentController()
obj = co.owner
mouse = co.sensors["Mouse"]
lmotion = co.actuators["LMove"]
wmotion = co.actuators["WMove"]

# Transform the mouse coordinates to see how far the mouse has moved.
def mousePos():
   x = (bge.render.getWindowWidth() / 2 - mouse.position[0]) * scale[0]
   y = (bge.render.getWindowHeight() / 2 - mouse.position[1]) * scale[1]
   return (x, y)

pos = mousePos()

# Set the amount of motion: X is applied in world coordinates...
wmotion.useLocalTorque = False
wmotion.torque = ((0.0, 0.0, pos[0]))

# ...Y is applied in local coordinates
lmotion.useLocalTorque = True
lmotion.torque = ((-pos[1], 0.0, 0.0))

# Activate both actuators
co.activate(lmotion)
co.activate(wmotion)

# Centre the mouse
bge.render.setMousePosition(int(bge.render.getWindowWidth() / 2), int(bge.render.getWindowHeight() / 2))

Constants

bge.render.KX_TEXFACE_MATERIAL

Materials as defined by the texture face settings.

bge.render.KX_BLENDER_MULTITEX_MATERIAL

Materials approximating blender materials with multitexturing.

bge.render.KX_BLENDER_GLSL_MATERIAL

Materials approximating blender materials with GLSL.

bge.render.VSYNC_OFF

Disables vsync

bge.render.VSYNC_ON

Enables vsync

bge.render.VSYNC_ADAPTIVE

Enables adaptive vsync if supported. Adaptive vsync enables vsync if the framerate is above the monitors refresh rate. Otherwise, vsync is diabled if the framerate is too low.

Functions

bge.render.getWindowWidth()

Gets the width of the window (in pixels)

Return type:integer

bge.render.getWindowHeight()

Gets the height of the window (in pixels)

Return type:integer

bge.render.setWindowSize(width, height)

Set the width and height of the window (in pixels). This also works for fullscreen applications.

bge.render.setFullScreen(enable)

Set whether or not the window should be fullscreen.

bge.render.getFullScreen()

Returns whether or not the window is fullscreen.

Return type:bool

bge.render.makeScreenshot(filename)

Writes a screenshot to the given filename.

If filename starts with // the image will be saved relative to the current directory. If the filename contains # it will be replaced with the frame number.

The standalone player saves .png files. It does not support color space conversion or gamma correction.

When run from Blender, makeScreenshot supports all Blender image file formats like PNG, TGA, Jpeg and OpenEXR. Gamma, Colorspace conversion and Jpeg compression are taken from the Render settings panels.

bge.render.enableVisibility(visible)

Doesn’t really do anything...

bge.render.showMouse(visible)

Enables or disables the operating system mouse cursor.

bge.render.setMousePosition(x, y)

Sets the mouse cursor position.

bge.render.setBackgroundColor(rgba)

Sets the window background color.

bge.render.setMistColor(rgb)

Sets the mist color.

bge.render.setAmbientColor(rgb)

Sets the color of ambient light.

bge.render.setMistStart(start)

Sets the mist start value. Objects further away than start will have mist applied to them.

bge.render.setMistEnd(end)

Sets the mist end value. Objects further away from this will be colored solid with the color set by setMistColor().

bge.render.disableMist()

Disables mist.

Note

Set any of the mist properties to enable mist.

bge.render.setEyeSeparation(eyesep)

Sets the eye separation for stereo mode. Usually Focal Length/30 provides a confortable value.

Parameters:eyesep (float) – The distance between the left and right eye.

bge.render.getEyeSeparation()

Gets the current eye separation for stereo mode.

Return type:float

bge.render.setFocalLength(focallength)

Sets the focal length for stereo mode. It uses the current camera focal length as initial value.

Parameters:focallength (float) – The focal length.

bge.render.getFocalLength()

Gets the current focal length for stereo mode.

Return type:float

bge.render.setMaterialMode(mode)

Set the material mode to use for OpenGL rendering.

Note

Changes will only affect newly created scenes.

bge.render.getMaterialMode(mode)

Get the material mode to use for OpenGL rendering.

Return type:KX_TEXFACE_MATERIAL, KX_BLENDER_MULTITEX_MATERIAL, KX_BLENDER_GLSL_MATERIAL

bge.render.setGLSLMaterialSetting(setting, enable)

Enables or disables a GLSL material setting.

bge.render.getGLSLMaterialSetting(setting, enable)

Get the state of a GLSL material setting.

Return type:boolean

bge.render.setAnisotropicFiltering(level)

Set the anisotropic filtering level for textures.

Parameters:level (integer (must be one of 1, 2, 4, 8, 16)) – The new anisotropic filtering level to use

Note

Changing this value can cause all textures to be recreated, which can be slow.

bge.render.getAnisotropicFiltering()

Get the anisotropic filtering level used for textures.

Return type:integer (one of 1, 2, 4, 8, 16)

bge.render.setMipmapping(value)

Change how to use mipmapping.

Note

Changing this value can cause all textures to be recreated, which can be slow.

bge.render.getMipmapping()

Get the current mipmapping setting.

Return type:RAS_MIPMAP_NONE, RAS_MIPMAP_NEAREST, RAS_MIPMAP_LINEAR

bge.render.drawLine(fromVec, toVec, color)

Draw a line in the 3D scene.

Parameters:

• fromVec (list [x, y, z]) – the origin of the line
• toVec (list [x, y, z]) – the end of the line
• color (list [r, g, b]) – the color of the line

bge.render.enableMotionBlur(factor)

Enable the motion blur effect.

Parameters:factor (float [0.0 - 1.0]) – the ammount of motion blur to display.

bge.render.disableMotionBlur()

Disable the motion blur effect.

bge.render.setVsync(value)

Set the vsync value

Parameters:value (integer) – One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE

bge.render.getVsync()

Get the current vsync value

Return type:One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE