Libraries.Game.Graphics.PixelMap

The PixelMap class represents an image as a collection of individual pixels. It is used by the Texture class to draw shapes and load images from files. This is a class used internally by the game engine, and most users will not need to interface with this class directly.

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action will create new PixelMap data to be used in OpenGL with the given width, height, and Format.

This action will create OpenGL information for the currently loaded PixelMap information.

This action will free up the memory used to store the pixel information of the image. This should only be used when the PixelMap is no longer needed.

This action will draw a hollow circle at the given point with the given radius using the given color.

This action will draw a hollow circle at the given point with the given radius using the given color code.

This action will draw a line on the PixelMap between the two points given using the given color.

This action will draw a line on the PixelMap between the two points given using the given color code.

This action will draw a different PixelMap starting from the destX and destY with sourceWidth and sourceHeight on top of this PixelMap at the coordinates of sourceX, sourceY.

This action takes a different PixelMap and draws it on top of this PixelMap at the given x,y coordinates on this PixelMap.

This action will draw a hollow rectangle at the given point with the given width and height using the given color.

This action will draw a hollow rectangle at the given point with the given width and height using the given color code.

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

This action will fill the complete bitmap with the given color code.

This action will fill the complete bitmap with the given color.

This action will draw a solid circle at the given point with the given radius using the given color code.

This action will draw a solid circle at the given point with the given radius using the given color.

This action will draw a solid rectangle at the given point with the given width and height using the given color.

This action will draw a solid rectangle at the given point with the given width and height using the given color code.

This action will draw a solid triangle using the three given points and the given color.

This action will draw a solid triangle using the three given points and the given color.

This action will return the Blending being used on this PixelMap.

Returns the color being applied to this PixelMap.

Returns the Format that is used by this PixelMap.

This action returns an integer value representing the internal GL format.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Returns the height of this PixelMap.

This action will return an integer color code representing the color of the pixel at the given coordinates.

Returns the width of this PixelMap.

This action will asynchronously load the PixelMap (that is, it will be loaded separately from the rest of the program's execution) and then it will be loaded into the provided Texture, which will be used to load the provided Drawable (if it is not undefined). This is only needed for use on the web, and when loading Drawables or Textures directly via files or file paths, it is called automatically. Most users will never need to use this action directly.

This action will load a matrix into the PixelMap to create a monochrome (black and white) image. Each value is assumed to be between 0 and 1, where 0 represents a black pixel and 1 represents a white pixel.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.PixelMap
    use Libraries.Game.Graphics.Drawable
    use Libraries.Game.Graphics.Texture
    use Libraries.Compute.Matrix

    class Main is Game

        PixelMap pixelMap
        Texture texture
        Drawable drawable

        action Main
            StartGame()
        end

        action CreateGame
            Matrix matrix

            // 7x7 square that is black at edges and lightens as it goes towards the center.
            matrix:Fill(7, 7, 0)
            matrix:Set(1, 1, 0.33)
            matrix:Set(2, 1, 0.33)
            matrix:Set(3, 1, 0.33)
            matrix:Set(4, 1, 0.33)
            matrix:Set(5, 1, 0.33)
            matrix:Set(5, 2, 0.33)
            matrix:Set(5, 3, 0.33)
            matrix:Set(5, 4, 0.33)
            matrix:Set(5, 5, 0.33)
            matrix:Set(4, 5, 0.33)
            matrix:Set(3, 5, 0.33)
            matrix:Set(2, 5, 0.33)
            matrix:Set(1, 5, 0.33)
            matrix:Set(1, 4, 0.33)
            matrix:Set(1, 3, 0.33)
            matrix:Set(1, 2, 0.33)

            matrix:Set(2, 2, 0.66)
            matrix:Set(3, 2, 0.66)
            matrix:Set(4, 2, 0.66)
            matrix:Set(4, 3, 0.66)
            matrix:Set(4, 4, 0.66)
            matrix:Set(3, 4, 0.66)
            matrix:Set(2, 4, 0.66)
            matrix:Set(2, 3, 0.66)

            matrix:Set(3, 3, 1)

            pixelMap:LoadMatrix(matrix)

            // Loading the PixelMap and blowing up the size of the Drawable to make it easier to see.
            texture:LoadFromPixelMap(pixelMap)
            drawable:Load(texture)
            Add(drawable)

            drawable:SetPosition(200, 200)
            drawable:SetSize(100, 100)
        end
    end

This action will load a PixelMap using an image file.

This action will set the Blending to be used for this PixelMap.

Sets the color being used by this PixelMap using a Color object.

Sets the color being used by this PixelMap using color component values between 0 and 1 for the red, green, blue, and alpha components.

Sets the color being used by this PixelMap using an integer color code.

Sets the type of interpolation Filter to be used for this PixelMap.

This action will set the pixel at the given coordinates with the PixelMap's current color.

This action will set the pixel at the given coordinates with the given color code.

This action will set the pixel at the given coordinates with the given color.

This action will set the scaling filter to the given type.