FrameBuffer

java.lang.Object
- FrameBuffer

public class FrameBuffer
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

int height

int[] pixel_buffer

int width

double[] z_buffer

Fields
Modifier and Type	Field and Description
`int`	`height`
`int[]`	`pixel_buffer`
`int`	`width`
`double[]`	`z_buffer`

Constructor Summary

Constructors
Constructor and Description
`FrameBuffer(int w, int h)` Construct a FrameBuffer with the given dimensions.
`FrameBuffer(java.lang.String inputFileName)` Construct a FrameBuffer from a PPM image file.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearFB(java.awt.Color c)` Clear the framebuffer (set a background color) and clear the framebuffer's z-buffer.
`void`	`clearVP(java.awt.Color c)` Clear the viewport (set a background color) and clear the viewport's z-buffer.
`void`	`clearzFB()` Clear the framebuffer's z-buffer (the depth buffer).
`void`	`clearzVP()` Clear the viewport's z-buffer (the depth buffer).
`FrameBuffer`	`convertVP2FB()` Convert the viewport into a framebuffer.
`FrameBuffer`	`convertZB2FB()` Convert the z-buffer into a framebuffer that holds a gray scale color value representing each pixels "depth".
`void`	`dumpFB2File(java.lang.String filename)` Write the framebuffer to the specified file.
`void`	`dumpPixels2File(int ul_x, int ul_y, int lr_x, int lr_y, java.lang.String filename)` Write a rectangular sub array of pixels to the specified file.
`void`	`dumpVP2File(java.lang.String filename)` Write the viewport to the specified file.
`void`	`fbTest()` A simple test of the framebuffer.
`double`	`getDepthFB(int x, int y)` Get the depth of the pixel with coordinates (x,y) in the framebuffer.
`double`	`getDepthVP(int x, int y)` Get the depth of the pixel with coordinates (x,y) relative to the current viewport.
`int`	`getHeightFB()` Get the height of the framebuffer.
`int`	`getHeightVP()` Get the height of the viewport.
`java.awt.Color`	`getPixelFB(int x, int y)` Get the color of the pixel with coordinates (x,y) in the framebuffer.
`java.awt.Color`	`getPixelVP(int x, int y)` Get the color of the pixel with coordinates (x,y) relative to the current viewport.
`int`	`getWidthFB()` Get the width of the framebuffer.
`int`	`getWidthVP()` Get the width of the viewport.
`static void`	`main(java.lang.String[] args)` A main() method for testing the FrameBuffer class.
`void`	`setPixelFB(int x, int y, java.awt.Color c)` Set the color of the pixel with coordinates (x,y) in the framebuffer.
`void`	`setPixelFB(int x, int y, java.awt.Color c, double z)` Set the color and depth of the pixel with coordinates (x,y) in the framebuffer.
`void`	`setPixelFB(int x, int y, double z)` Set the depth of the pixel with coordinates (x,y) in the framebuffer.
`void`	`setPixelVP(int x, int y, java.awt.Color c)` Set the color of the pixel with coordinates (x,y) relative to the current viewport.
`void`	`setPixelVP(int x, int y, java.awt.Color c, double z)` Set the color and depth of the pixel with coordinates (x,y) relative to the current viewport.
`void`	`setPixelVP(int x, int y, double z)` Set the depth of the pixel with coordinates (x,y) relative to the current viewport.
`void`	`setViewport(int vp_ul_x, int vp_ul_y, int width, int height)` Set the coordinates, within the FrameBuffer, of the viewport's upper-left-hand corner, width, and height.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - width
```
public int width
```
  - height
```
public int height
```
  - pixel_buffer
```
public int[] pixel_buffer
```
  - z_buffer
```
public double[] z_buffer
```
- Constructor Detail
  - FrameBuffer
```
public FrameBuffer(int w,
           int h)
```
    Construct a FrameBuffer with the given dimensions. Initialize the framebuffer to hold all black pixels.
    
    Parameters:
    w - Width of the FrameBuffer.
    h - Height of the FrameBuffer.
  - FrameBuffer
```
public FrameBuffer(java.lang.String inputFileName)
```
    Construct a FrameBuffer from a PPM image file. This can be used to initialize a FrameBuffer with a background image.
    
    Parameters:
    inputFileName - Must name a PPM image file with magic number P6.
- Method Detail
  - getWidthFB
```
public int getWidthFB()
```
    Get the width of the framebuffer.
  - getHeightFB
```
public int getHeightFB()
```
    Get the height of the framebuffer.
  - clearFB
```
public void clearFB(java.awt.Color c)
```
    Clear the framebuffer (set a background color) and clear the framebuffer's z-buffer.
  - clearzFB
```
public void clearzFB()
```
    Clear the framebuffer's z-buffer (the depth buffer).
  - setViewport
```
public void setViewport(int vp_ul_x,
               int vp_ul_y,
               int width,
               int height)
```
    Set the coordinates, within the FrameBuffer, of the viewport's upper-left-hand corner, width, and height. (Using upper-left-hand corner, width, and height is like Java's Rectangle class and Graphics.drawRect() method.)
  - getWidthVP
```
public int getWidthVP()
```
    Get the width of the viewport.
  - getHeightVP
```
public int getHeightVP()
```
    Get the height of the viewport.
  - clearVP
```
public void clearVP(java.awt.Color c)
```
    Clear the viewport (set a background color) and clear the viewport's z-buffer.
  - clearzVP
```
public void clearzVP()
```
    Clear the viewport's z-buffer (the depth buffer).
  - getPixelFB
```
public java.awt.Color getPixelFB(int x,
                        int y)
```
    Get the color of the pixel with coordinates (x,y) in the framebuffer.
  - getDepthFB
```
public double getDepthFB(int x,
                int y)
```
    Get the depth of the pixel with coordinates (x,y) in the framebuffer.
  - setPixelFB
```
public void setPixelFB(int x,
              int y,
              java.awt.Color c)
```
    Set the color of the pixel with coordinates (x,y) in the framebuffer.
  - setPixelFB
```
public void setPixelFB(int x,
              int y,
              double z)
```
    Set the depth of the pixel with coordinates (x,y) in the framebuffer.
  - setPixelFB
```
public void setPixelFB(int x,
              int y,
              java.awt.Color c,
              double z)
```
    Set the color and depth of the pixel with coordinates (x,y) in the framebuffer.
  - getPixelVP
```
public java.awt.Color getPixelVP(int x,
                        int y)
```
    Get the color of the pixel with coordinates (x,y) relative to the current viewport.
  - getDepthVP
```
public double getDepthVP(int x,
                int y)
```
    Get the depth of the pixel with coordinates (x,y) relative to the current viewport.
  - setPixelVP
```
public void setPixelVP(int x,
              int y,
              java.awt.Color c)
```
    Set the color of the pixel with coordinates (x,y) relative to the current viewport.
  - setPixelVP
```
public void setPixelVP(int x,
              int y,
              double z)
```
    Set the depth of the pixel with coordinates (x,y) relative to the current viewport.
  - setPixelVP
```
public void setPixelVP(int x,
              int y,
              java.awt.Color c,
              double z)
```
    Set the color and depth of the pixel with coordinates (x,y) relative to the current viewport.
  - convertZB2FB
```
public FrameBuffer convertZB2FB()
```
    Convert the z-buffer into a framebuffer that holds a gray scale color value representing each pixels "depth". z-buffer values are between -1.0 and 1.0. -1.0 represents the front of the scene. 1.0 represents the back of the scene. Make things near the front look darker and things near the back look lighter.
  - convertVP2FB
```
public FrameBuffer convertVP2FB()
```
    Convert the viewport into a framebuffer.
  - dumpFB2File
```
public void dumpFB2File(java.lang.String filename)
```
    Write the framebuffer to the specified file.
  - dumpVP2File
```
public void dumpVP2File(java.lang.String filename)
```
    Write the viewport to the specified file.
  - dumpPixels2File
```
public void dumpPixels2File(int ul_x,
                   int ul_y,
                   int lr_x,
                   int lr_y,
                   java.lang.String filename)
```
    Write a rectangular sub array of pixels to the specified file. http://stackoverflow.com/questions/2693631/read-ppm-file-and-store-it-in-an-array-coded-with-c
  - fbTest
```
public void fbTest()
```
    A simple test of the framebuffer. It fills the framebuffer with a test pattern.
  - main
```
public static void main(java.lang.String[] args)
```
    A main() method for testing the FrameBuffer class.

Class FrameBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

pixel_buffer

z_buffer

Constructor Detail

FrameBuffer

FrameBuffer

Method Detail

getWidthFB

getHeightFB

clearFB

clearzFB

setViewport

getWidthVP

getHeightVP

clearVP

clearzVP

getPixelFB

getDepthFB

setPixelFB

setPixelFB

setPixelFB

getPixelVP

getDepthVP

setPixelVP

setPixelVP

setPixelVP

convertZB2FB

convertVP2FB

dumpFB2File

dumpVP2File

dumpPixels2File

fbTest

main