Sprite Factory

ReadMe
Release Notes
Overview
Using the Editor
Upgrading

Concepts
Sprites
Master Sprites
Sprite Groups
Colliders
Locators
Material Sets
SpriteUpdater
SpriteCamera

Advanced
Working in Multiple Projects

Classes
Runtime Classes

Videos
Overview
Creating Sprites
Sprite Inspector
Frame Events
Collision System
Locator System
Material Sets

Links
Sprite Factory Site
Web Documentation
Support
Contact

SpriteFactory.SpriteCamera

Namespace: SpriteFactory
Inherits from MonoBehaviour

A companion to the Camera component that allows you to size the camera to render sprites at actual pixel size on the screen.

See SpriteCamera for more information.

Variables

       
Name   Type   Description
renderAtActualPixelSize   bool   Size camera to render Sprites so 1 texel equals 1 pixel on screen.
         
Editor-Only Variables       These variables are only for use in the editor. They have no effect in a final build.
showResolutionGate   bool   Display a resolution box on screen to help visualize available screen space.
resolutionGateSize   SpriteCamera.DisplayResolution   The size of the resolution gate displayed on screen.
rotateGateLayout   bool   Rotate the resolution gate to portrait or landscape.
customGateWidth   int   Width of the resolution gate if showResolutionGate is set to Custom.
customGateHeight   int   Height of the resolution gate if showResolutionGate is set to Custom.
resolutionGateColor   Color   Color of the resolution gate.
         
Internal Variables       For internal use only. Do not edit these variables.
gameSettings   GameSettings   Link to the GameSettings file of SpriteFactory. * Do not edit this value. *

 

Functions

Name   Description
SetCameraToActualPixelSize   Size camera to render Sprites so 1 texel equals 1 pixel on screen.
RevertCameraSize   Change camera back to previous render size setting before setting to render at actual pixel size.

 

Inherited Variables and Functions

All variables and functions in MonoBehaviour are inherited by this class.

 

Enumerations

Name   Description
DisplayResolution   Display resolutions for the resolution gate.