mod

Documentation

Index

• type Filter
  • func ConformToPalleteInPlace(p color.Palette) Filter
  • func InPlace(m render.Modification) Filter
• type Mod

Types

type Filter

type Filter func(*image.RGBA)

A Filter modifies an input image in place. This is useful notably for modifying a screen buffer, as they will refuse to be modified in any other way. This cannot change the dimensions of the underlying image.

func ConformToPalleteInPlace

func ConformToPalleteInPlace(p color.Palette) Filter

ConformToPalleteInPlace is not a modification, but acts like ConformToPallete without allocating a new *image.RGBA

func InPlace

func InPlace(m render.Modification) Filter

InPlace converts a Mod to a Filter.

type Mod

type Mod func(image.Image) *image.RGBA

A Mod takes an image and returns that image transformed in some way. This type is identical to render.Modification, and in 2.0 render.Modification will be replaced with this, but this is currently not used.