material

Documentation

Overview

Package material provides material and texture related types and functions

Index

• type HitRecord
• type Isotropic
  • func (m Isotropic) Scatter(rayIn geo.Ray, rec *HitRecord) (bool, ScatterRecord)
  • func (m Isotropic) ScatteringPdf(rec *HitRecord, scattered geo.Ray) float64
• type LightEmittingMaterial
• type Material
  • func NewDielectric(tex Texture, indexOfRefraction float64) Material
  • func NewLambertian(tex Texture) Material
  • func NewLight(r, g, b float64) Material
  • func NewMetal(tex Texture, fuzz float64) Material
• type NonLightEmittingMaterial
  • func (m NonLightEmittingMaterial) Emitted(rec *HitRecord) geo.Vec3
  • func (m NonLightEmittingMaterial) IsLight() bool
• type NonPdfGeneratingMaterial
  • func (m NonPdfGeneratingMaterial) ScatteringPdf(rec *HitRecord, scattered geo.Ray) float64
• type PdfGeneratingMaterial
• type ScatterRecord
• type SolidColor
  • func (sc SolidColor) Color(rec *HitRecord) geo.Vec3
• type Texture
  • func LoadImageTexture(path string) (Texture, error)
  • func NewImageTexture(image im.Image, mirror bool) Texture
  • func NewSolidColor(r, g, b float64) Texture

Types

type HitRecord

type HitRecord struct {
	HitPoint  geo.Vec3
	Normal    geo.Vec3
	Material  Material
	RayLength float64
	U         float64
	V         float64
	FrontFace bool
}

HitRecord is a collection of all interesting properties from when a ray hits a hittable object

type Isotropic

type Isotropic struct {
	NonLightEmittingMaterial
	Albedo Texture
}

Isotropic is a fog type material Should not be used directly, but is used internally by ConstantMedium hittable

func (Isotropic) Scatter

func (m Isotropic) Scatter(rayIn geo.Ray, rec *HitRecord) (bool, ScatterRecord)

Scatter returns a randomly scattered ray in any direction

func (Isotropic) ScatteringPdf

func (m Isotropic) ScatteringPdf(rec *HitRecord, scattered geo.Ray) float64

ScatteringPdf returns the pdf value for a given rays for the isotropic material

type LightEmittingMaterial

type LightEmittingMaterial interface {
	Emitted(rec *HitRecord) geo.Vec3
}

LightEmittingMaterial is a material that can emit light

type Material

type Material interface {
	PdfGeneratingMaterial
	LightEmittingMaterial
	IsLight() bool
	Scatter(rayIn geo.Ray, rec *HitRecord) (bool, ScatterRecord)
}

Material is the interface for types that describe how a ray behaves when hitting an object.

func NewDielectric

func NewDielectric(tex Texture, indexOfRefraction float64) Material

NewDielectric creates a new dielectric material

func NewLambertian

func NewLambertian(tex Texture) Material

NewLambertian creates a lambertian material

func NewLight

func NewLight(r, g, b float64) Material

NewLight creates a new diffuse light material

func NewMetal

func NewMetal(tex Texture, fuzz float64) Material

NewMetal creates a metal material

type NonLightEmittingMaterial

type NonLightEmittingMaterial struct{}

NonLightEmittingMaterial is to be used by materials that do not emit light

func (NonLightEmittingMaterial) Emitted

func (m NonLightEmittingMaterial) Emitted(rec *HitRecord) geo.Vec3

Emitted a non emitting material emits zero light

func (NonLightEmittingMaterial) IsLight

func (m NonLightEmittingMaterial) IsLight() bool

IsLight a non emitting material is not a light

type NonPdfGeneratingMaterial

type NonPdfGeneratingMaterial struct{}

NonPdfGeneratingMaterial is to be used by materials that do not use pdfs

func (NonPdfGeneratingMaterial) ScatteringPdf

func (m NonPdfGeneratingMaterial) ScatteringPdf(rec *HitRecord, scattered geo.Ray) float64

ScatteringPdf as NonPdfGeneratingMaterial is used for materials that do not generate a pdf Just return 0

type PdfGeneratingMaterial

type PdfGeneratingMaterial interface {
	ScatteringPdf(rec *HitRecord, scattered geo.Ray) float64
}

PdfGeneratingMaterial is a material that can use pdfs for scattering of rays

type ScatterRecord

type ScatterRecord struct {
	Attenuation geo.Vec3
	Pdf         pdf.Pdf
	SkipPdf     bool
	SkipPdfRay  geo.Ray
}

ScatterRecord is a collection of attributes from the scattering of a ray with a material

type SolidColor

type SolidColor struct {
	ColorValue geo.Vec3
}

SolidColor is a texture with just the same color everywhere

func (SolidColor) Color

func (sc SolidColor) Color(rec *HitRecord) geo.Vec3

Color returns the solid color

type Texture

type Texture interface {
	Color(rec *HitRecord) geo.Vec3
}

Texture describes the color of a material. The color can vary by the uv coordinates of the hittable

func LoadImageTexture

func LoadImageTexture(path string) (Texture, error)

LoadImageTexture creates a texture that uses image data for color by loading the image from the path

func NewImageTexture

func NewImageTexture(image im.Image, mirror bool) Texture

NewImageTexture creates a texture that uses image data for color

func NewSolidColor

func NewSolidColor(r, g, b float64) Texture