textqueue

package module

v0.4.2 Latest Latest Go to latest Published: Jun 11, 2022 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/oakmound/grove

Links

Open Source Insights

README ¶

textqueue

The textqueue component displays text input via event handlers in a vertical queue, with older texts fading away after a delay.

Documentation ¶

Index ¶

Constants
Variables
func PrintBind(tq *TextQueue, str string) event.Response
type TextQueue
- func New(ctx *scene.Context, registeredEvents []event.UnsafeEventID, ...) *TextQueue

Constants ¶

View Source

const DisplayTextEvent = "DisplayText"

Variables ¶

View Source

var (
	// TextQueuePublish: Triggered to publish an update to a specific text queue
	TextQueuePublish = event.RegisterEvent[string]()
)

Functions ¶

func PrintBind ¶

func PrintBind(tq *TextQueue, str string) event.Response

Types ¶

type TextQueue ¶

type TextQueue struct {
	event.CallerID
	render.LayeredPoint
	// contains filtered or unexported fields
}

A TextQueue is a renderable entity that displays text in a column for a brief time before fading the text and dropping it. It accepts new text elements from the DisplayTextEvent event.

func New ¶

func New(ctx *scene.Context, registeredEvents []event.UnsafeEventID, pos floatgeom.Point2, layer int, font *render.Font, sustainTime time.Duration) *TextQueue

New creates a customized TextQueue.

func (*TextQueue) CID ¶

func (tq *TextQueue) CID() event.CallerID

func (*TextQueue) Draw ¶

func (tq *TextQueue) Draw(buff draw.Image, xOff, yOff float64)

Draw the textqueue's contents

func (*TextQueue) GetDims ¶

func (tq *TextQueue) GetDims() (int, int)

GetDims needs to have some size so give it the minimal one.

Source Files ¶

View all Source files

textqueue.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL