ebiten/internal/opengl/framebuffer.go

// Copyright 2014 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package opengl

// Framebuffer is a wrapper of OpenGL's framebuffer.
//
// TODO: Create a new struct Image and embed this struct.
type Framebuffer struct {
	native    framebufferNative
	proMatrix []float32
	width     int
	height    int
}

// NewFramebufferFromTexture creates a framebuffer from the given texture.
func NewFramebufferFromTexture(texture Texture, width, height int) (*Framebuffer, error) {
	native, err := theContext.newFramebuffer(texture)
	if err != nil {
		return nil, err
	}
	return &Framebuffer{
		native: native,
		width:  width,
		height: height,
	}, nil
}

// NewScreenFramebuffer creates a framebuffer for the screen.
func NewScreenFramebuffer(width, height int) *Framebuffer {
	return &Framebuffer{
		native: theContext.getScreenFramebuffer(),
		width:  width,
		height: height,
	}
}

// ProjectionMatrix returns a projection matrix of the framebuffer.
//
// A projection matrix converts the coodinates on the framebuffer
// (0, 0) - (viewport width, viewport height)
// to the normalized device coodinates (-1, -1) - (1, 1) with adjustment.
func (f *Framebuffer) ProjectionMatrix() []float32 {
	if f.proMatrix != nil {
		return f.proMatrix
	}
	f.proMatrix = orthoProjectionMatrix(0, f.width, 0, f.height)
	return f.proMatrix
}

func (f *Framebuffer) Delete() {
	if f.native != theContext.getScreenFramebuffer() {
		theContext.deleteFramebuffer(f.native)
	}
}