com.sun.prism

Interface ResourceFactory

All Superinterfaces:

GraphicsResource

All Known Subinterfaces:

ShaderFactory

All Known Implementing Classes:

BaseResourceFactory, BaseShaderFactory, ES2ResourceFactory

public interface ResourceFactory
extends GraphicsResource

Method Summary

Modifier and Type	Method and Description
void	addFactoryListener(ResourceFactoryListener l)
ShapeRep	createArcRep()
ShapeRep	createEllipseRep()
Texture	createFloatTexture(int width, int height)
Texture	createMaskTexture(int width, int height, Texture.WrapMode wrapMode)
Mesh	createMesh()
MeshView	createMeshView(Mesh mesh)
ShapeRep	createPathRep()
PhongMaterial	createPhongMaterial()
Presentable	createPresentable(PresentableState pState)
ShapeRep	createRoundRectRep()
RTTexture	createRTTexture(int width, int height, Texture.WrapMode wrapMode)
RTTexture	createRTTexture(int width, int height, Texture.WrapMode wrapMode, boolean msaa)
Texture	createTexture(Image image, Texture.Usage usageHint, Texture.WrapMode wrapMode) Returns a new Texture containing the pixels from the given image with the indicated texture edge wrap mode.
Texture	createTexture(Image image, Texture.Usage usageHint, Texture.WrapMode wrapMode, boolean useMipmap) Returns a new Texture containing the pixels from the given image with the indicated texture edge wrap mode.
Texture	createTexture(MediaFrame frame) Returns a new Texture that can contain the video image as specified in the provided MediaFrame.
Texture	createTexture(PixelFormat formatHint, Texture.Usage usageHint, Texture.WrapMode wrapMode, int w, int h) Returns a new Texture with the given format and edge wrapping support.
Texture	createTexture(PixelFormat formatHint, Texture.Usage usageHint, Texture.WrapMode wrapMode, int w, int h, boolean useMipmap) Returns a new Texture with the given format and edge wrapping support.
void	dispose()
Texture	getCachedTexture(Image image, Texture.WrapMode wrapMode) Returns a Texture for the given image set up to use or simulate the indicated wrap mode.
Texture	getCachedTexture(Image image, Texture.WrapMode wrapMode, boolean useMipmap) Returns a Texture for the given image set up to use or simulate the indicated wrap mode.
Texture	getGlyphTexture()
int	getMaximumTextureSize() Returns the maximum supported texture dimension for this device.
Texture	getRegionTexture()
int	getRTTHeight(int h, Texture.WrapMode wrapMode)
int	getRTTWidth(int w, Texture.WrapMode wrapMode)
TextureResourcePool	getTextureResourcePool()
boolean	isCompatibleTexture(Texture tex) A Texture may have been obtained from a different resource factory.
boolean	isDeviceReady() Returns status of this graphics device.
boolean	isFormatSupported(PixelFormat format) Returns true if the given PixelFormat is supported; otherwise returns false.
boolean	isSuperShaderAllowed()
boolean	isWrapModeSupported(Texture.WrapMode mode) Returns true iff the indicated wrap mode is directly supported (i.e.
void	removeFactoryListener(ResourceFactoryListener l)
void	setGlyphTexture(Texture texture)
void	setRegionTexture(Texture texture)

Method Detail

isDeviceReady

boolean isDeviceReady()

Returns status of this graphics device. If the device is not ready the createRTTexture and present operations will fail. Creation of shaders and regular textures will succeed and return valid resources. All hardware resources (RenderTargets and SwapChains) have to be recreated after a device-lost event notification.

getTextureResourcePool

TextureResourcePool getTextureResourcePool()

createTexture

Texture createTexture(Image image,
                      Texture.Usage usageHint,
                      Texture.WrapMode wrapMode)

Returns a new Texture containing the pixels from the given image with the indicated texture edge wrap mode. Note that the dimensions of the returned texture may be larger than those of the given image.

Equivalent to (but perhaps more efficient than):

     PixelFormat format = image.getPixelFormat();
     int w = image.getWidth();
     int h = image.getHeight();
     Texture tex = createTexture(format, usageHint, wrapMode, w, h);
     tex.update(image, 0, 0, w, h);
 

Parameters:

image - the pixel data to be uploaded to the new texture

usageHint - the Dynamic vs. Static nature of the texture data

wrapMode - the desired edge behavior (clamping vs. wrapping)

Returns:

a new texture

createTexture

Texture createTexture(Image image,
                      Texture.Usage usageHint,
                      Texture.WrapMode wrapMode,
                      boolean useMipmap)

Returns a new Texture containing the pixels from the given image with the indicated texture edge wrap mode. Note that the dimensions of the returned texture may be larger than those of the given image.

Equivalent to (but perhaps more efficient than):

     PixelFormat format = image.getPixelFormat();
     int w = image.getWidth();
     int h = image.getHeight();
     Texture tex = createTexture(format, usageHint, wrapMode, w, h, useMipmap);
     tex.update(image, 0, 0, w, h);
 

Parameters:

image - the pixel data to be uploaded to the new texture

usageHint - the Dynamic vs. Static nature of the texture data

wrapMode - the desired edge behavior (clamping vs. wrapping)

useMipmap - the flag indicates should texture be created with mipmap

Returns:

a new texture

createTexture

Texture createTexture(PixelFormat formatHint,
                      Texture.Usage usageHint,
                      Texture.WrapMode wrapMode,
                      int w,
                      int h)

Returns a new Texture with the given format and edge wrapping support. Note that the dimensions of the returned texture may be larger than those requested and the wrap mode may be a simulated version of the type requested.

Parameters:

formatHint - intended pixel format of the data to be stored in this texture

usageHint - the Dynamic vs. Static nature of the texture data

wrapMode - intended wrap mode to be used for the texture

w - width of the content in the texture

h - height of the content in the texture

Returns:

texture most appropriate for the given intended format, wrap mode and dimensions

createTexture

Texture createTexture(PixelFormat formatHint,
                      Texture.Usage usageHint,
                      Texture.WrapMode wrapMode,
                      int w,
                      int h,
                      boolean useMipmap)

Returns a new Texture with the given format and edge wrapping support. Note that the dimensions of the returned texture may be larger than those requested and the wrap mode may be a simulated version of the type requested.

Parameters:

formatHint - intended pixel format of the data to be stored in this texture

usageHint - the Dynamic vs. Static nature of the texture data

wrapMode - intended wrap mode to be used for the texture

w - width of the content in the texture

h - height of the content in the texture

useMipmap - the flag indicates should texture be created with mipmap

Returns:

texture most appropriate for the given intended format, wrap mode and dimensions

createTexture

Texture createTexture(MediaFrame frame)

Returns a new Texture that can contain the video image as specified in the provided MediaFrame. Note that padding is almost implicit since this method has to accommodate the line strides of each plane. Also due to renderer limitations, some format conversion may be necessary so the texture format may end up being different from the video image format.

Parameters:

frame - the video image that we need to create a new texture for

Returns:

texture most appropriate for the given video image.

getCachedTexture

Texture getCachedTexture(Image image,
                         Texture.WrapMode wrapMode)

Returns a Texture for the given image set up to use or simulate the indicated wrap mode. If no texture could be found in the cache, this method will create a new texture and put it in the cache before returning it. NOTE: the caller of this method should not hold a reference to the cached texture beyond its immediate needs since the cache may be cleared at any time.

Parameters:

image - the pixel data to be uploaded if the texture is new or needs new fringe pixels to simulate a new wrap mode

wrapMode - the mode that describes the behavior for samples outside the content area

Returns:

a cached texture

getCachedTexture

Texture getCachedTexture(Image image,
                         Texture.WrapMode wrapMode,
                         boolean useMipmap)

Returns a Texture for the given image set up to use or simulate the indicated wrap mode. If no texture could be found in the cache, this method will create a new texture and put it in the cache before returning it. NOTE: the caller of this method should not hold a reference to the cached texture beyond its immediate needs since the cache may be cleared at any time.

Parameters:

image - the pixel data to be uploaded if the texture is new or needs new fringe pixels to simulate a new wrap mode

wrapMode - the mode that describes the behavior for samples outside the content

useMipmap - the flag indicates should mipmapping be used for this texture

Returns:

a cached texture

isFormatSupported

boolean isFormatSupported(PixelFormat format)

Returns true if the given PixelFormat is supported; otherwise returns false.

Note that the following formats are guaranteed to be supported across all devices:

     BYTE_RGB
     BYTE_RGBA_PRE
     BYTE_GRAY
     BYTE_ALPHA
 

Support for the other formats depends on the capabilities of the device. Be sure to call this method before attempting to create a Texture with a non-standard format and plan to have an alternate codepath if the given format is not supported.

Parameters:

format - the PixelFormat to test

Returns:

true if the given format is supported; false otherwise

isWrapModeSupported

boolean isWrapModeSupported(Texture.WrapMode mode)

Returns true iff the indicated wrap mode is directly supported (i.e. not simulated) by the underlying pipeline and platform.

Parameters:

mode - the desired WrapMode

Returns:

true iff the wrap mode is supported and not simulated

getMaximumTextureSize

int getMaximumTextureSize()

Returns the maximum supported texture dimension for this device. For example, if this method returns 2048, it means that textures larger than 2048x2048 cannot be created.

Returns:

the maximum supported texture dimension

getRTTWidth

int getRTTWidth(int w,
                Texture.WrapMode wrapMode)

getRTTHeight

int getRTTHeight(int h,
                 Texture.WrapMode wrapMode)

createMaskTexture

Texture createMaskTexture(int width,
                          int height,
                          Texture.WrapMode wrapMode)

createFloatTexture

Texture createFloatTexture(int width,
                           int height)

createRTTexture

RTTexture createRTTexture(int width,
                          int height,
                          Texture.WrapMode wrapMode)

createRTTexture

RTTexture createRTTexture(int width,
                          int height,
                          Texture.WrapMode wrapMode,
                          boolean msaa)

isCompatibleTexture

boolean isCompatibleTexture(Texture tex)

A Texture may have been obtained from a different resource factory.

Parameters:

tex - the texture to check.

Returns:

whether this texture is compatible.

createPresentable

Presentable createPresentable(PresentableState pState)

createPathRep

ShapeRep createPathRep()

createRoundRectRep

ShapeRep createRoundRectRep()

createEllipseRep

ShapeRep createEllipseRep()

createArcRep

ShapeRep createArcRep()

addFactoryListener

void addFactoryListener(ResourceFactoryListener l)

removeFactoryListener

void removeFactoryListener(ResourceFactoryListener l)

setRegionTexture

void setRegionTexture(Texture texture)

getRegionTexture

Texture getRegionTexture()

setGlyphTexture

void setGlyphTexture(Texture texture)

getGlyphTexture

Texture getGlyphTexture()

isSuperShaderAllowed

boolean isSuperShaderAllowed()

dispose

void dispose()

Specified by:

dispose in interface GraphicsResource

createPhongMaterial

PhongMaterial createPhongMaterial()

createMeshView

MeshView createMeshView(Mesh mesh)

createMesh

Mesh createMesh()