SiliconStudio.Shaders.Parser.IncludeHandler Interface Reference

Callback interface to handle included file requested by the PreProcessor. More...

Inheritance diagram for SiliconStudio.Shaders.Parser.IncludeHandler:

Public Member Functions
Stream	Open (IncludeType type, string fileName, Stream parentStream)
	A user-implemented method for opening and reading the contents of a shader #include file. More...
void	Close (Stream stream)
	A user-implemented method for closing a shader #include file. More...

Detailed Description

Callback interface to handle included file requested by the PreProcessor.

Definition at line 10 of file IncludeHandler.cs.

Member Function Documentation

void SiliconStudio.Shaders.Parser.IncludeHandler.Close

(

Stream

stream

)

A user-implemented method for closing a shader #include file.

If IncludeHandler.Open was successful, Close is guaranteed to be called before the API using the IncludeHandler interface returns.

Parameters

stream

This is a reference that was returned by the corresponding IncludeHandler.Open call.

Implemented in SiliconStudio.Shaders.Parser.DefaultIncludeHandler.

Stream SiliconStudio.Shaders.Parser.IncludeHandler.Open	(	IncludeType	type,
		string	fileName,
		Stream	parentStream
	)

A user-implemented method for opening and reading the contents of a shader #include file.

Parameters

type	A IncludeType-typed value that indicates the location of the #include file.
fileName	Name of the #include file.
parentStream	Pointer to the container that includes the #include file.

Returns

Stream that is associated with fileName to be read. This reference remains valid until IncludeHandler.Close is called.

Implemented in SiliconStudio.Shaders.Parser.DefaultIncludeHandler.

---

The documentation for this interface was generated from the following file:

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/common/shaders/SiliconStudio.Shaders/Parser/IncludeHandler.cs