Skip to main content

TextureGenerator

const txtGen = new TextureGenerator(folderPath: string, osbFolderPath: string, fontProps?: IFontProperties)

Used to generate texture.

  • folderPath: full path to the folder that will be used to save generated text images.
  • osbFolderPath: relative path to the folder that will be used to save generated text images. For example: sb/lyrics
  • fontProps:
interface IFontProperties {
    fontSize: number // default: 72px
    fontName: string // default: Arial
}

Instance methods​

generateTexture​

txtGen.generateTexture(
    text: string,
    useBoundingBox: boolean = false,
    color?: { 
        r: number, 
        g: number, 
        b: number
    }, 
    offset?: {
        left?: number
        right?: number
        top?: number
        bottom?: number
    }
) : Texture

Generate and save text image. Offset will be 0 on each side if not set. Returns a Texture that contains info about the width, height and osb path of the generated image.

  • text: Text.
  • useBoundingBox: Whether bounding box should be included in the calculation or not. If you are creating any sorts of per character effect this should be true and the Origin should be set to TopLeft, TopCenter or TopRight depends on your need so that the text can be aligned properly. However if you just wanna generate a whole line of text then just leave it as false so your texture doesn't have extra unncessary paddings.
  • color: default: 0,0,0
  • offset: default: 0,0,0,0

getTextDimensions​

txtGen.getTextDimensions(
    text: string,
    useBoundingBox: boolean = false,
    offset?: {
        left?: number
        right?: number
        top?: number
        bottom?: number
    }
) : { width: number, height: number }

Return text dimensions without caching it.

  • text: Text.
    • useBoundingBox: Whether bounding box should be included in the calculation or not. If you are creating any sorts of per character effect this should be true and the Origin should be set to TopLeft, TopCenter or TopRight depends on your need so that the text can be aligned properly. However if you just wanna generate a whole line of text then just leave it as false so your texture doesn't have extra unncessary paddings.
  • offset: default: 0,0,0,0

emptyDir​

txtGen.emptyDir()

Clear folder that is used to save generated text image.

registerFont​

txtGen.registerFont(fontPath: string, family: string, weight?: string, style?: string)

Register a new font. Must be called before generateTexture if you are using a font file that is not installed as a system font. family, weight, style must follow css @font-face rules.

  • fontPath: full path to font file.
  • family: font family.
  • weight: font weight.
  • style: font style.

Example​

const folderPath = ""
const txtGen = new TextureGenerator(folderPath, "sb/lyrics")

let line = {
    text: "Hello",
    startTime: 1000,
    endTime: 2000
}

let texture = txtGen.generateTexture(line.text)

let sprite = texture.toSprite(texture.osbPath, Layer.Background, Origin.Center, {
    x: 320,
    y: 400,
})

sprite.ScaleAtTime(line.startTime, 1)
sprite.Fade(line.startTime - 200, line.startTime, 0, 1)
sprite.Fade(line.endTime - 200, line.endTime, 1, 0)