Viewport

Page Summary

• The Viewport class defines a rectangular area on the screen for rendering.

• It provides methods to set and retrieve the viewport's dimensions and position (x, y, width, height).

• Viewport can be used to control the visible area of a 3D scene or a 2D image.

• Methods like setGLViewport and setGLScissor allow interaction with OpenGL for rendering control.

• The class includes utility methods like getAsArray and toString for data management and debugging.

public class Viewport

Defines a viewport rectangle.

Fields

public int	height
public int	width
public int	x
public int	y

Public Constructors

Viewport()

Public Methods

boolean	equals(Object obj)
void	getAsArray(int[] array, int offset) Stores the viewport parameters into an int array.
int	hashCode()
void	setGLScissor() Sets the current OpenGL scissor rect based on the current viewport settings.
void	setGLViewport() Sets the current OpenGL viewport based on the current viewport settings.
void	setViewport(int x, int y, int width, int height) Sets a new viewport based on the provided coordinates and dimensions.
String	toString() Returns a string containing a concise, human-readable description of this object.

Inherited Methods

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Fields

public int height

public int width

public int x

public int y

Public Constructors

public Viewport ()

Public Methods

public boolean equals (Object obj)

Parameters

obj

public void getAsArray (int[] array, int offset)

Stores the viewport parameters into an int array.

Parameters

array	Array to store values in.
offset	Offset into the array to start writing values in.

Throws

IllegalArgumentException	If there is not enough space to write the result.

public int hashCode ()

public void setGLScissor ()

Sets the current OpenGL scissor rect based on the current viewport settings.

public void setGLViewport ()

Sets the current OpenGL viewport based on the current viewport settings.

public void setViewport (int x, int y, int width, int height)

Sets a new viewport based on the provided coordinates and dimensions.

Parameters

x	Horizontal pixel coordinate of the bottom-left corner of the viewport.
y	Vertical pixel coordinate of the bottom-left corner of the viewport.
width	Width of the viewport in pixels.
height	Height of the viewport in pixels.

public String toString ()

Returns a string containing a concise, human-readable description of this object.

Returns

• A printable representation of this object.