Context Navigation

source: branches/HeuristicLab.BinPacking/PackingPlanVisualizations/SharpDX/SharpDX.Toolkit.Compiler.xml @ 13083

Visit:

Last change on this file since 13083 was 13028, checked in by gkronber, 9 years ago

added PackingPlanVisualizations plugin received from jhelm.
this project also contains necessary binaries of SharpDX
visualization in HL works now

File size: 35.7 KB

Rev	Line
[13028]	1	<?xml version="1.0"?>
	2	<doc>
	3	<assembly>
	4	<name>SharpDX.Toolkit.Compiler</name>
	5	</assembly>
	6	<members>
	7	<member name="T:SharpDX.Toolkit.Graphics.Ast">
	8	<summary>
	9	A simple ast used to store technique/pass parsing result.
	10	</summary>
	11	</member>
	12	<member name="T:SharpDX.Toolkit.Graphics.Ast.Node">
	13	<summary>
	14	Root node for all ast objects.
	15	</summary>
	16	</member>
	17	<member name="T:SharpDX.Toolkit.Graphics.Ast.Expression">
	18	<summary>
	19	Root node for all expressions.
	20	</summary>
	21	</member>
	22	<member name="T:SharpDX.Toolkit.Graphics.Ast.Statement">
	23	<summary>
	24	Root node for all statements.
	25	</summary>
	26	</member>
	27	<member name="T:SharpDX.Toolkit.Graphics.Ast.Identifier">
	28	<summary>
	29	An identifier.
	30	</summary>
	31	</member>
	32	<member name="M:SharpDX.Toolkit.Graphics.Ast.Identifier.#ctor">
	33	<summary>
	34	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Identifier"/> class.
	35	</summary>
	36	</member>
	37	<member name="M:SharpDX.Toolkit.Graphics.Ast.Identifier.#ctor(System.String)">
	38	<summary>
	39	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Identifier"/> class.
	40	</summary>
	41	<param name="text">The name.</param>
	42	</member>
	43	<member name="F:SharpDX.Toolkit.Graphics.Ast.Identifier.Text">
	44	<summary>
	45	The identifier as a string.
	46	</summary>
	47	</member>
	48	<member name="F:SharpDX.Toolkit.Graphics.Ast.Identifier.IsIndirect">
	49	<summary>
	50	Is an indirect reference using <...>.
	51	</summary>
	52	</member>
	53	<member name="T:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier">
	54	<summary>
	55	An indexed identifier.
	56	</summary>
	57	</member>
	58	<member name="M:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier.#ctor">
	59	<summary>
	60	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier"/> class.
	61	</summary>
	62	</member>
	63	<member name="M:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier.#ctor(System.String,System.Int32)">
	64	<summary>
	65	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier"/> class.
	66	</summary>
	67	<param name="text">The name.</param>
	68	<param name="index">The index.</param>
	69	</member>
	70	<member name="F:SharpDX.Toolkit.Graphics.Ast.IndexedIdentifier.Index">
	71	<summary>
	72	The index
	73	</summary>
	74	</member>
	75	<member name="T:SharpDX.Toolkit.Graphics.Ast.Literal">
	76	<summary>
	77	A literal value.
	78	</summary>
	79	</member>
	80	<member name="M:SharpDX.Toolkit.Graphics.Ast.Literal.#ctor">
	81	<summary>
	82	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Literal"/> class.
	83	</summary>
	84	</member>
	85	<member name="M:SharpDX.Toolkit.Graphics.Ast.Literal.#ctor(System.Object)">
	86	<summary>
	87	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Literal"/> class.
	88	</summary>
	89	<param name="value">The value.</param>
	90	</member>
	91	<member name="F:SharpDX.Toolkit.Graphics.Ast.Literal.Value">
	92	<summary>
	93	The literal value.
	94	</summary>
	95	</member>
	96	<member name="T:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement">
	97	<summary>
	98	An expression statement.
	99	</summary>
	100	</member>
	101	<member name="M:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement.#ctor">
	102	<summary>
	103	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement"/> class.
	104	</summary>
	105	</member>
	106	<member name="M:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement.#ctor(SharpDX.Toolkit.Graphics.Ast.Expression)">
	107	<summary>
	108	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement"/> class.
	109	</summary>
	110	<param name="expression">The expression.</param>
	111	</member>
	112	<member name="F:SharpDX.Toolkit.Graphics.Ast.ExpressionStatement.Expression">
	113	<summary>
	114	The Expression.
	115	</summary>
	116	</member>
	117	<member name="T:SharpDX.Toolkit.Graphics.Ast.ArrayInitializerExpression">
	118	<summary>
	119	An array initialzer {...} expression.
	120	</summary>
	121	</member>
	122	<member name="M:SharpDX.Toolkit.Graphics.Ast.ArrayInitializerExpression.#ctor">
	123	<summary>
	124	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.ArrayInitializerExpression"/> class.
	125	</summary>
	126	</member>
	127	<member name="F:SharpDX.Toolkit.Graphics.Ast.ArrayInitializerExpression.Values">
	128	<summary>
	129	List of values.
	130	</summary>
	131	</member>
	132	<member name="T:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression">
	133	<summary>
	134	A reference to an identifier.
	135	</summary>
	136	</member>
	137	<member name="M:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression.#ctor">
	138	<summary>
	139	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression"/> class.
	140	</summary>
	141	</member>
	142	<member name="M:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression.#ctor(SharpDX.Toolkit.Graphics.Ast.Identifier)">
	143	<summary>
	144	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression"/> class.
	145	</summary>
	146	<param name="name">The name.</param>
	147	</member>
	148	<member name="F:SharpDX.Toolkit.Graphics.Ast.IdentifierExpression.Name">
	149	<summary>
	150	The identifier referenced by this expression.
	151	</summary>
	152	</member>
	153	<member name="T:SharpDX.Toolkit.Graphics.Ast.AssignExpression">
	154	<summary>
	155	An assign expression name = value.
	156	</summary>
	157	</member>
	158	<member name="M:SharpDX.Toolkit.Graphics.Ast.AssignExpression.#ctor">
	159	<summary>
	160	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.AssignExpression"/> class.
	161	</summary>
	162	</member>
	163	<member name="M:SharpDX.Toolkit.Graphics.Ast.AssignExpression.#ctor(SharpDX.Toolkit.Graphics.Ast.Identifier,SharpDX.Toolkit.Graphics.Ast.Expression)">
	164	<summary>
	165	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.AssignExpression"/> class.
	166	</summary>
	167	<param name="name">The name.</param>
	168	<param name="value">The value.</param>
	169	</member>
	170	<member name="F:SharpDX.Toolkit.Graphics.Ast.AssignExpression.Name">
	171	<summary>
	172	The identifier receiver.
	173	</summary>
	174	</member>
	175	<member name="F:SharpDX.Toolkit.Graphics.Ast.AssignExpression.Value">
	176	<summary>
	177	The value to assign.
	178	</summary>
	179	</member>
	180	<member name="T:SharpDX.Toolkit.Graphics.Ast.LiteralExpression">
	181	<summary>
	182	A literal expression.
	183	</summary>
	184	</member>
	185	<member name="M:SharpDX.Toolkit.Graphics.Ast.LiteralExpression.#ctor">
	186	<summary>
	187	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.LiteralExpression"/> class.
	188	</summary>
	189	</member>
	190	<member name="M:SharpDX.Toolkit.Graphics.Ast.LiteralExpression.#ctor(SharpDX.Toolkit.Graphics.Ast.Literal)">
	191	<summary>
	192	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.LiteralExpression"/> class.
	193	</summary>
	194	<param name="value">The value.</param>
	195	</member>
	196	<member name="T:SharpDX.Toolkit.Graphics.Ast.CompileExpression">
	197	<summary>
	198	A compile expression (old style d3d9: compile vx_2_0 VS();).
	199	</summary>
	200	</member>
	201	<member name="M:SharpDX.Toolkit.Graphics.Ast.CompileExpression.#ctor">
	202	<summary>
	203	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.CompileExpression"/> class.
	204	</summary>
	205	</member>
	206	<member name="M:SharpDX.Toolkit.Graphics.Ast.CompileExpression.#ctor(SharpDX.Toolkit.Graphics.Ast.Identifier,SharpDX.Toolkit.Graphics.Ast.Expression)">
	207	<summary>
	208	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.CompileExpression"/> class.
	209	</summary>
	210	<param name="profile"></param>
	211	<param name="method"></param>
	212	</member>
	213	<member name="T:SharpDX.Toolkit.Graphics.Ast.MethodExpression">
	214	<summary>
	215	A method expression.
	216	</summary>
	217	</member>
	218	<member name="M:SharpDX.Toolkit.Graphics.Ast.MethodExpression.#ctor">
	219	<summary>
	220	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.MethodExpression"/> class.
	221	</summary>
	222	</member>
	223	<member name="F:SharpDX.Toolkit.Graphics.Ast.MethodExpression.Name">
	224	<summary>
	225	Name of the method.
	226	</summary>
	227	</member>
	228	<member name="F:SharpDX.Toolkit.Graphics.Ast.MethodExpression.Arguments">
	229	<summary>
	230	Arguments.
	231	</summary>
	232	</member>
	233	<member name="T:SharpDX.Toolkit.Graphics.Ast.Pass">
	234	<summary>
	235	A HLSL 'pass'.
	236	</summary>
	237	</member>
	238	<member name="M:SharpDX.Toolkit.Graphics.Ast.Pass.#ctor">
	239	<summary>
	240	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Pass"/> class.
	241	</summary>
	242	</member>
	243	<member name="F:SharpDX.Toolkit.Graphics.Ast.Pass.Name">
	244	<summary>
	245	Name of the pass.
	246	</summary>
	247	<remarks>
	248	Can be null.
	249	</remarks>
	250	</member>
	251	<member name="F:SharpDX.Toolkit.Graphics.Ast.Pass.Statements">
	252	<summary>
	253	List of statements.
	254	</summary>
	255	</member>
	256	<member name="T:SharpDX.Toolkit.Graphics.Ast.Technique">
	257	<summary>
	258	A HLSL 'technique'.
	259	</summary>
	260	</member>
	261	<member name="M:SharpDX.Toolkit.Graphics.Ast.Technique.#ctor">
	262	<summary>
	263	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Technique"/> class.
	264	</summary>
	265	</member>
	266	<member name="F:SharpDX.Toolkit.Graphics.Ast.Technique.Name">
	267	<summary>
	268	Name of the technique.
	269	</summary>
	270	<remarks>
	271	Can be null.
	272	</remarks>
	273	</member>
	274	<member name="F:SharpDX.Toolkit.Graphics.Ast.Technique.Passes">
	275	<summary>
	276	List of passes.
	277	</summary>
	278	</member>
	279	<member name="T:SharpDX.Toolkit.Graphics.Ast.Shader">
	280	<summary>
	281	Root ast for a shader.
	282	</summary>
	283	</member>
	284	<member name="M:SharpDX.Toolkit.Graphics.Ast.Shader.#ctor">
	285	<summary>
	286	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Ast.Shader"/> class.
	287	</summary>
	288	</member>
	289	<member name="F:SharpDX.Toolkit.Graphics.Ast.Shader.Techniques">
	290	<summary>
	291	List of techniques.
	292	</summary>
	293	</member>
	294	<member name="T:SharpDX.Toolkit.Graphics.EffectCompilerInternal">
	295	<summary>
	296	Main class used to compile a Toolkit FX file.
	297	</summary>
	298	</member>
	299	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.CheckForChanges(System.String)">
	300	<summary>
	301	Checks for changes from a dependency file.
	302	</summary>
	303	<param name="dependencyFilePath">The dependency file path.</param>
	304	<returns><c>true</c> if a file has been updated, <c>false</c> otherwise</returns>
	305	</member>
	306	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.CompileFromFile(System.String,SharpDX.Toolkit.Graphics.EffectCompilerFlags,System.Collections.Generic.List{SharpDX.Toolkit.Graphics.EffectData.ShaderMacro},System.Collections.Generic.List{System.String},System.Boolean,System.String)">
	307	<summary>
	308	Compiles an effect from file.
	309	</summary>
	310	<param name="filePath">The file path.</param>
	311	<param name="flags">The flags.</param>
	312	<param name="macros">The macrosArgs.</param>
	313	<param name="includeDirectoryList">The include directory list.</param>
	314	<param name="alloDynamicCompiling">if set to <c>true</c> [allo dynamic compiling].</param>
	315	<param name="dependencyFilePath">The dependency file path.</param>
	316	<returns>The result of compilation.</returns>
	317	</member>
	318	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.Compile(System.String,System.String,SharpDX.Toolkit.Graphics.EffectCompilerFlags,System.Collections.Generic.List{SharpDX.Toolkit.Graphics.EffectData.ShaderMacro},System.Collections.Generic.List{System.String},System.Boolean,System.String)">
	319	<summary>
	320	Compiles an effect from the specified source code and filepath.
	321	</summary>
	322	<param name="sourceCode">The source code.</param>
	323	<param name="filePath">The file path.</param>
	324	<param name="flags">The flags.</param>
	325	<param name="macrosArgs">The macrosArgs.</param>
	326	<param name="includeDirectoryList">The include directory list.</param>
	327	<param name="allowDynamicCompiling">if set to <c>true</c> [allow dynamic compiling].</param>
	328	<param name="dependencyFilePath">The dependency file path.</param>
	329	<returns>The result of compilation.</returns>
	330	</member>
	331	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.DisassembleShader(SharpDX.Toolkit.Graphics.EffectData.Shader)">
	332	<summary>
	333	Disassembles a shader HLSL bytecode to asm code.
	334	</summary>
	335	<param name="shader">The shader.</param>
	336	<returns>A string containing asm code decoded from HLSL bytecode.</returns>
	337	</member>
	338	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.BuildParameters(SharpDX.Toolkit.Graphics.EffectData.Shader,SharpDX.D3DCompiler.ShaderReflection)">
	339	<summary>
	340	Builds the parameters for a particular shader.
	341	</summary>
	342	<param name="shader"> The shader to build parameters. </param>
	343	</member>
	344	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.BuildConstantBufferParameter(SharpDX.D3DCompiler.ShaderReflectionVariable)">
	345	<summary>
	346	Builds an effect parameter from a reflection variable.
	347	</summary>
	348	<returns> an EffectParameter, null if not handled </returns>
	349	</member>
	350	<member name="M:SharpDX.Toolkit.Graphics.EffectCompilerInternal.BuildResourceParameter(System.String,SharpDX.D3DCompiler.InputBindingDescription)">
	351	<summary>
	352	Builds an effect parameter from a reflection variable.
	353	</summary>
	354	<returns> an EffectParameter, null if not handled </returns>
	355	</member>
	356	<member name="T:SharpDX.Toolkit.Graphics.EffectCompiler">
	357	<summary>
	358	Main class used to compile a Toolkit FX file.
	359	</summary>
	360	</member>
	361	<member name="M:SharpDX.Toolkit.Graphics.EffectCompiler.CheckForChanges(System.String)">
	362	<summary>
	363	Checks for changes from a dependency file.
	364	</summary>
	365	<param name="dependencyFilePath">The dependency file path.</param>
	366	<returns><c>true</c> if a file has been updated, <c>false</c> otherwise</returns>
	367	</member>
	368	<member name="M:SharpDX.Toolkit.Graphics.EffectCompiler.CompileFromFile(System.String,SharpDX.Toolkit.Graphics.EffectCompilerFlags,System.Collections.Generic.List{SharpDX.Toolkit.Graphics.EffectData.ShaderMacro},System.Collections.Generic.List{System.String},System.Boolean,System.String)">
	369	<summary>
	370	Compiles an effect from file.
	371	</summary>
	372	<param name="filePath">The file path.</param>
	373	<param name="flags">The flags.</param>
	374	<param name="macros">The macrosArgs.</param>
	375	<param name="includeDirectoryList">The include directory list.</param>
	376	<returns>The result of compilation.</returns>
	377	</member>
	378	<member name="M:SharpDX.Toolkit.Graphics.EffectCompiler.Compile(System.String,System.String,SharpDX.Toolkit.Graphics.EffectCompilerFlags,System.Collections.Generic.List{SharpDX.Toolkit.Graphics.EffectData.ShaderMacro},System.Collections.Generic.List{System.String},System.Boolean,System.String)">
	379	<summary>
	380	Compiles an effect from the specified source code and filepath.
	381	</summary>
	382	<param name="sourceCode">The source code.</param>
	383	<param name="filePath">The file path.</param>
	384	<param name="flags">The flags.</param>
	385	<param name="macrosArgs">The macrosArgs.</param>
	386	<param name="includeDirectoryList">The include directory list.</param>
	387	<returns>The result of compilation.</returns>
	388	</member>
	389	<member name="M:SharpDX.Toolkit.Graphics.EffectCompiler.DisassembleShader(SharpDX.Toolkit.Graphics.EffectData.Shader)">
	390	<summary>
	391	Disassembles a shader HLSL bytecode to asm code.
	392	</summary>
	393	<param name="shader">The shader.</param>
	394	<returns>A string containing asm code decoded from HLSL bytecode.</returns>
	395	</member>
	396	<member name="T:SharpDX.Toolkit.Graphics.EffectDataCodeWriter">
	397	<summary>
	398	Use this class to generate a code with embedded effect bytecode.
	399	</summary>
	400	</member>
	401	<member name="F:SharpDX.Toolkit.Graphics.EffectDataCodeWriter.ClassDeclaration">
	402	<summary>
	403	Gets or sets the class declaration (Default: "public partial").
	404	</summary>
	405	</member>
	406	<member name="F:SharpDX.Toolkit.Graphics.EffectDataCodeWriter.Namespace">
	407	<summary>
	408	Gets or sets the namespace.
	409	</summary>
	410	</member>
	411	<member name="F:SharpDX.Toolkit.Graphics.EffectDataCodeWriter.ClassName">
	412	<summary>
	413	Gets or sets the classname.
	414	</summary>
	415	</member>
	416	<member name="F:SharpDX.Toolkit.Graphics.EffectDataCodeWriter.FieldDeclaration">
	417	<summary>
	418	Gets or sets the field declaration (default: "private").
	419	</summary>
	420	</member>
	421	<member name="F:SharpDX.Toolkit.Graphics.EffectDataCodeWriter.FieldName">
	422	<summary>
	423	Gets or sets the field name (default: "effectByteCode").
	424	</summary>
	425	</member>
	426	<member name="M:SharpDX.Toolkit.Graphics.FileDependencyList.#ctor">
	427	<summary>
	428	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.FileDependencyList"/> class.
	429	</summary>
	430	</member>
	431	<member name="M:SharpDX.Toolkit.Graphics.FileDependencyList.CheckForChanges">
	432	<summary>
	433	Checks for changes in the dependency file.
	434	</summary>
	435	<returns><c>true</c> if a file has been updated, <c>false</c> otherwise</returns>
	436	</member>
	437	<member name="F:SharpDX.Toolkit.Graphics.EffectParser.EndOfFile">
	438	<summary>
	439	End of file token.
	440	</summary>
	441	</member>
	442	<member name="M:SharpDX.Toolkit.Graphics.EffectParser.#ctor">
	443	<summary>
	444	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.EffectParser"/> class.
	445	</summary>
	446	</member>
	447	<member name="M:SharpDX.Toolkit.Graphics.EffectParser.PrepareParsing(System.String,System.String)">
	448	<summary>
	449	Parses the specified input.
	450	</summary>
	451	<param name="input">The input.</param>
	452	<param name="fileName">Name of the file.</param>
	453	<returns>Result of parsing</returns>
	454	</member>
	455	<member name="M:SharpDX.Toolkit.Graphics.EffectParser.ContinueParsing(SharpDX.Toolkit.Graphics.EffectParserResult)">
	456	<summary>
	457	Continues the parsing.
	458	</summary>
	459	<param name="previousParsing">The previous parsing.</param>
	460	<returns>EffectParserResult.</returns>
	461	</member>
	462	<member name="M:SharpDX.Toolkit.Graphics.EffectParser.Parse(System.String,System.String)">
	463	<summary>
	464	Parses the specified input.
	465	</summary>
	466	<param name="input">The input.</param>
	467	<param name="fileName">Name of the file.</param>
	468	<returns>Result of parsing</returns>
	469	</member>
	470	<member name="P:SharpDX.Toolkit.Graphics.EffectParser.IncludeFileCallback">
	471	<summary>
	472	Gets or sets the include file callback.
	473	</summary>
	474	<value>The include file callback.</value>
	475	</member>
	476	<member name="P:SharpDX.Toolkit.Graphics.EffectParser.Macros">
	477	<summary>
	478	Gets the macros.
	479	</summary>
	480	<value>The macros.</value>
	481	</member>
	482	<member name="P:SharpDX.Toolkit.Graphics.EffectParser.IncludeDirectoryList">
	483	<summary>
	484	Gets the include directory list.
	485	</summary>
	486	<value>The include directory list.</value>
	487	</member>
	488	<member name="P:SharpDX.Toolkit.Graphics.EffectParser.Logger">
	489	<summary>
	490	Gets or sets the logger.
	491	</summary>
	492	<value>The logger.</value>
	493	</member>
	494	<member name="T:SharpDX.Toolkit.Graphics.FontCompilerResult">
	495	<summary>
	496	Result of a compilation.
	497	</summary>
	498	</member>
	499	<member name="P:SharpDX.Toolkit.Graphics.FontCompilerResult.HasErrors">
	500	<summary>
	501	Gets a value indicating whether this instance has errors.
	502	</summary>
	503	<value><c>true</c> if this instance has errors; otherwise, <c>false</c>.</value>
	504	</member>
	505	<member name="P:SharpDX.Toolkit.Graphics.FontCompilerResult.Logger">
	506	<summary>
	507	Gets the logger containing compilation messages..
	508	</summary>
	509	<value>The logger.</value>
	510	</member>
	511	<member name="T:SharpDX.Toolkit.Graphics.FontCompiler">
	512	<summary>
	513	Main class used to compile a Font file XML file.
	514	</summary>
	515	</member>
	516	<member name="M:SharpDX.Toolkit.Graphics.FontCompiler.CompileAndSave(System.String,System.String,System.String)">
	517	<summary>
	518	Compiles an XML font file description to a file. Optionally output dependency file.
	519	</summary>
	520	<param name="sourceXmlFile">The source XML file.</param>
	521	<param name="outputFile">The output file.</param>
	522	<param name="dependencyFile">The dependency file.</param>
	523	<returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
	524	</member>
	525	<member name="M:SharpDX.Toolkit.Graphics.FontCompiler.Compile(SharpDX.Toolkit.Graphics.FontDescription,System.IO.Stream)">
	526	<summary>
	527	Compiles the specified font description into a <see cref="T:SharpDX.Toolkit.Graphics.SpriteFontData"/> object.
	528	</summary>
	529	<param name="fontDescription">The font description.</param>
	530	<param name="stream">The stream to output the compiled SpriteFontData.</param>
	531	<returns>A SpriteFontData object.</returns>
	532	</member>
	533	<member name="M:SharpDX.Toolkit.Graphics.FontCompiler.Compile(SharpDX.Toolkit.Graphics.FontDescription)">
	534	<summary>
	535	Compiles the specified font description into a <see cref="T:SharpDX.Toolkit.Graphics.SpriteFontData"/> object.
	536	</summary>
	537	<param name="fontDescription">The font description.</param>
	538	<returns>A SpriteFontData object.</returns>
	539	</member>
	540	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.FontName">
	541	<summary>
	542	Input can be either a system (TrueType) font or a specially marked bitmap file.
	543	</summary>
	544	</member>
	545	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.Size">
	546	<summary>
	547	Size and style for TrueType fonts (ignored when converting a bitmap font).
	548	</summary>
	549	</member>
	550	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.Spacing">
	551	<summary>
	552	Character spacing overrides. Zero is default spacing, negative closer together, positive further apart
	553	</summary>
	554	</member>
	555	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.LineSpacing">
	556	<summary>
	557	Line spacing overrides. Zero is default spacing, negative closer together, positive further apart
	558	</summary>
	559	</member>
	560	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.UseKerning">
	561	<summary>
	562	Specifies whether to use kerning information when rendering the font. Default value is false (NOT SUPPORTED YET).
	563	</summary>
	564	</member>
	565	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.Format">
	566	<summary>
	567	Format of the output texture. Values: 'auto', 'rgba32', 'bgra4444', 'compressedmono'. Default is 'auto'
	568	</summary>
	569	</member>
	570	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.CharacterRegions">
	571	<summary>
	572	Which characters to include in the font (eg. "/CharacterRegion:0x20-0x7F /CharacterRegion:0x123")
	573	</summary>
	574	</member>
	575	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.DefaultCharacter">
	576	<summary>
	577	Fallback character used when asked to render a codepoint that is not
	578	included in the font. If zero, missing characters throw exceptions.
	579	</summary>
	580	</member>
	581	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.Style">
	582	<summary>
	583	Style for the font. 'regular', 'bold', 'italic', 'underline', 'strikeout'. Default is 'regular
	584	</summary>
	585	</member>
	586	<member name="F:SharpDX.Toolkit.Graphics.FontDescription.NoPremultiply">
	587	<summary>
	588	By default, font textures use premultiplied alpha format. Set this if you want interpolative alpha instead.
	589	</summary>
	590	</member>
	591	<member name="T:SharpDX.Toolkit.Graphics.FontStyle">
	592	<summary>
	593	Type of a font.
	594	</summary>
	595	</member>
	596	<member name="F:SharpDX.Toolkit.Graphics.FontStyle.Regular">
	597	<summary>
	598	A regular font.
	599	</summary>
	600	</member>
	601	<member name="F:SharpDX.Toolkit.Graphics.FontStyle.Bold">
	602	<summary>
	603	A bold font.
	604	</summary>
	605	</member>
	606	<member name="F:SharpDX.Toolkit.Graphics.FontStyle.Italic">
	607	<summary>
	608	An italic font.
	609	</summary>
	610	</member>
	611	<member name="F:SharpDX.Toolkit.Graphics.FontStyle.Underline">
	612	<summary>
	613	An underline font.
	614	</summary>
	615	</member>
	616	<member name="F:SharpDX.Toolkit.Graphics.FontStyle.Strikeout">
	617	<summary>
	618	A strikeout font.
	619	</summary>
	620	</member>
	621	<member name="T:SharpDX.Toolkit.Graphics.FontTextureFormat">
	622	<summary>
	623	Available output texture formats.
	624	</summary>
	625	</member>
	626	<member name="T:SharpDX.Toolkit.Graphics.SourceSpan">
	627	<summary>
	628	Location of a portion of source.
	629	</summary>
	630	</member>
	631	<member name="F:SharpDX.Toolkit.Graphics.SourceSpan.FilePath">
	632	<summary>
	633	Path of the file.
	634	</summary>
	635	</member>
	636	<member name="F:SharpDX.Toolkit.Graphics.SourceSpan.Column">
	637	<summary>
	638	Column of the span.
	639	</summary>
	640	</member>
	641	<member name="F:SharpDX.Toolkit.Graphics.SourceSpan.Line">
	642	<summary>
	643	Line of the span.
	644	</summary>
	645	</member>
	646	<member name="F:SharpDX.Toolkit.Graphics.SourceSpan.Index">
	647	<summary>
	648	Absolute index in the input string.
	649	</summary>
	650	</member>
	651	<member name="F:SharpDX.Toolkit.Graphics.SourceSpan.Length">
	652	<summary>
	653	Length of the source span in the input string.
	654	</summary>
	655	</member>
	656	<member name="T:SharpDX.Toolkit.Graphics.Token">
	657	<summary>
	658	Contains information about a token language.
	659	</summary>
	660	</member>
	661	<member name="M:SharpDX.Toolkit.Graphics.Token.#ctor(SharpDX.Toolkit.Graphics.TokenType,System.String,SharpDX.Toolkit.Graphics.SourceSpan)">
	662	<summary>
	663	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Graphics.Token"/> struct.
	664	</summary>
	665	<param name="type">The type.</param>
	666	<param name="value">The value.</param>
	667	<param name="span">The span.</param>
	668	</member>
	669	<member name="F:SharpDX.Toolkit.Graphics.Token.Type">
	670	<summary>
	671	The type of the token.
	672	</summary>
	673	</member>
	674	<member name="F:SharpDX.Toolkit.Graphics.Token.Value">
	675	<summary>
	676	Value of the token.
	677	</summary>
	678	</member>
	679	<member name="F:SharpDX.Toolkit.Graphics.Token.Span">
	680	<summary>
	681	The source span.
	682	</summary>
	683	</member>
	684	<member name="T:SharpDX.Toolkit.Graphics.Tokenizer">
	685	<summary>
	686	A simple tokenizer used to transform a HLSL sourcecode into a collection of tokens.
	687	</summary>
	688	<remarks>
	689	This tokenizer is used to parse tokens inside technique/pass block.
	690	See <see cref="T:SharpDX.Toolkit.Graphics.TokenType"/> for the list of tokens that are supported inside technique/pass.
	691	This tokenizer is not really efficient compare to a DFA (Deterministic Finite-state Automaton)
	692	parser but enough suitable in our case (120 files from DirectX SDK parsed in 2s).
	693	</remarks>
	694	</member>
	695	<member name="M:SharpDX.Toolkit.Graphics.Tokenizer.Run(System.String)">
	696	<summary>
	697	Runs the tokenizer on an input string.
	698	</summary>
	699	<param name="input">The string to decode to tokens.</param>
	700	<returns>An enumeration of tokens.</returns>
	701	</member>
	702	<member name="T:SharpDX.Toolkit.Graphics.TokenType">
	703	<summary>
	704	Type of a token language.
	705	</summary>
	706	</member>
	707	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Newline">
	708	<summary>
	709	A Newline.
	710	</summary>
	711	</member>
	712	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Identifier">
	713	<summary>
	714	An identifier.
	715	</summary>
	716	</member>
	717	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Hexa">
	718	<summary>
	719	A number in hexadecimal form.
	720	</summary>
	721	</member>
	722	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Number">
	723	<summary>
	724	A number.
	725	</summary>
	726	</member>
	727	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Equal">
	728	<summary>
	729	The symbol '='.
	730	</summary>
	731	</member>
	732	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Comma">
	733	<summary>
	734	A comma ','.
	735	</summary>
	736	</member>
	737	<member name="F:SharpDX.Toolkit.Graphics.TokenType.SemiColon">
	738	<summary>
	739	A Semicolon ';'.
	740	</summary>
	741	</member>
	742	<member name="F:SharpDX.Toolkit.Graphics.TokenType.LeftCurlyBrace">
	743	<summary>
	744	A left curly brace '{'.
	745	</summary>
	746	</member>
	747	<member name="F:SharpDX.Toolkit.Graphics.TokenType.RightCurlyBrace">
	748	<summary>
	749	A right curly brace '}'.
	750	</summary>
	751	</member>
	752	<member name="F:SharpDX.Toolkit.Graphics.TokenType.LeftParent">
	753	<summary>
	754	A left parenthesis '('.
	755	</summary>
	756	</member>
	757	<member name="F:SharpDX.Toolkit.Graphics.TokenType.RightParent">
	758	<summary>
	759	A right parenthesis ')'.
	760	</summary>
	761	</member>
	762	<member name="F:SharpDX.Toolkit.Graphics.TokenType.LeftBracket">
	763	<summary>
	764	A left bracket '['.
	765	</summary>
	766	</member>
	767	<member name="F:SharpDX.Toolkit.Graphics.TokenType.RightBracket">
	768	<summary>
	769	A right bracket ']'.
	770	</summary>
	771	</member>
	772	<member name="F:SharpDX.Toolkit.Graphics.TokenType.String">
	773	<summary>
	774	A string.
	775	</summary>
	776	</member>
	777	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Preprocessor">
	778	<summary>
	779	A preprocessor token '#'
	780	</summary>
	781	</member>
	782	<member name="F:SharpDX.Toolkit.Graphics.TokenType.DoubleColon">
	783	<summary>
	784	A double colon '::'.
	785	</summary>
	786	</member>
	787	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Dot">
	788	<summary>
	789	A dot '.'.
	790	</summary>
	791	</member>
	792	<member name="F:SharpDX.Toolkit.Graphics.TokenType.LessThan">
	793	<summary>
	794	A '<'.
	795	</summary>
	796	</member>
	797	<member name="F:SharpDX.Toolkit.Graphics.TokenType.GreaterThan">
	798	<summary>
	799	A '>'.
	800	</summary>
	801	</member>
	802	<member name="F:SharpDX.Toolkit.Graphics.TokenType.Unknown">
	803	<summary>
	804	An unknown symbol.
	805	</summary>
	806	</member>
	807	<member name="F:SharpDX.Toolkit.Graphics.TokenType.EndOfFile">
	808	<summary>
	809	A end of file token.
	810	</summary>
	811	</member>
	812	</members>
	813	</doc>

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Update cookies preferences